Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix and simplify logic that generates extension options docs #761

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix and simplify logic that generates extension options docs #761

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions site/docs/extensions/generate_function_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ def write_markdown(file_obj: dict, file_name: str) -> None:
mdFile.new_paragraph("Implementations:")
implementations_list = function_spec["impls"]
option_names_list = []
document_option_names_list = []
options_list = []
document_options = []

for count, impl in enumerate(implementations_list):
if "args" not in impl:
Expand Down Expand Up @@ -70,15 +69,14 @@ def write_markdown(file_obj: dict, file_name: str) -> None:
# enum with no defined name, will be named as the list of choices
if "name" in arg:
option_name = str(arg["name"])
document_option_names_list.append(option_name)
else:
option_name = choices

# Required enums will be prepended with `req_enum` inside the function
arg_string.append(option_name)
arg_with_option_names.append(option_name)
option_names_list.append(option_name)
options_list.append(choices)
document_options.append((option_name, choices))
else:
raise Exception(
f"Unrecognized argument found in "
Expand All @@ -88,12 +86,11 @@ def write_markdown(file_obj: dict, file_name: str) -> None:
opts = impl["options"] if "options" in impl else {}
for opt_name, opt in opts.items():
choices = str(opt["values"])
document_option_names_list.append(opt_name)
document_options.append((opt_name, choices))
option_name = f"option:{opt_name}"
arg_string.append(option_name)
arg_with_option_names.append(option_name)
option_names_list.append(option_name)
options_list.append(choices)

# If the implementation is variadic, the last argument will appear `min_args`,
# number of times in the implementation.
Expand All @@ -104,10 +101,6 @@ def write_markdown(file_obj: dict, file_name: str) -> None:
if len(only_arg_names) > 0:
only_arg_names.append(only_arg_names[-1])

document_option_names_list = list(
dict.fromkeys(document_option_names_list)
)
options_list = list(dict.fromkeys(options_list))
arg_values = [f"{x}" for x in arg_string]
options_and_arg_names = [f"{x}" for x in arg_with_option_names]
# reset the options names list for the next function implementation.
Expand Down Expand Up @@ -151,14 +144,11 @@ def write_markdown(file_obj: dict, file_name: str) -> None:
"""
Write markdown for options.
"""
if len(options_list) > 0 and len(document_option_names_list) > 0:
document_options = sorted(list(set(document_options)))
if len(document_options) > 0:
mdFile.new_paragraph("<details><summary>Options:</summary>")
mdFile.write("\n")
A = options_list
B = document_option_names_list
for options_list, option_name in (
zip(A, cycle(B)) if len(A) > len(B) else zip(cycle(A), B)
):
for option_name, options_list in document_options:
mdFile.new_line(f"<li>{option_name} {options_list} </li> ")

mdFile.new_paragraph("</details>")
Expand Down
Loading