Skip to content

Commit 3bf83a5

Browse files
committed
Rename screenshot argument to image in class_summary macro
Refactored the class_summary macro to use 'image' instead of 'screenshot' for clarity and consistency. Updated related variable names and markdown generation accordingly.
1 parent 0f395fd commit 3bf83a5

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/extras/macros/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ def class_all_options(class_name, separate_signature=True):
1616
"""
1717

1818
@env.macro
19-
def class_summary(class_name, screenshot=None):
19+
def class_summary(class_name, image=None):
2020
control_name = class_name.split(".")[-1]
21-
screenshot_md = f"\n\n![{control_name}]({screenshot})\n\n" if screenshot else ""
21+
image_md = f"\n\n![{control_name}]({image})\n\n" if image else ""
2222
return f"""
2323
::: {class_name}
2424
options:
2525
show_root_toc_entry: true
2626
extra:
2727
show_class_docstring: true
2828
29-
{screenshot_md}
29+
{image_md}
3030
3131
::: {class_name}
3232
options:

0 commit comments

Comments
 (0)