Skip to content

Special formatting of ranges as choices instead of listing entries #69

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

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

Special formatting of ranges as choices instead of listing entries #69

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
18 changes: 9 additions & 9 deletions sphinxarg/ext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ def render_list(l, markdown_help, settings=None):
return all_children


def format_choices(choices):
if isinstance(choices, range) and choices.step == 1:
return f'Value range: {choices.start} to {choices.stop}\n'
return f'Possible choices: {", ".join(str(c) for c in choices)}\n'


def _is_suppressed(item: str | None) -> bool:
"""Return whether item should not be printed."""
if item is None:
Expand Down Expand Up @@ -157,9 +163,7 @@ def print_action_groups(
# Build the help text
arg = []
if 'choices' in entry:
arg.append(
f"Possible choices: {', '.join(str(c) for c in entry['choices'])}\n"
)
arg.append(format_choices(entry['choices']))
if 'help' in entry:
arg.append(entry['help'])
if not _is_suppressed(entry['default']):
Expand Down Expand Up @@ -400,9 +404,7 @@ def _format_positional_arguments(self, parser_info):
elif 'choices' not in arg:
arg_items.append(nodes.paragraph(text='Undocumented'))
if 'choices' in arg:
arg_items.append(
nodes.paragraph(text='Possible choices: ' + ', '.join(arg['choices']))
)
arg_items.append(nodes.paragraph(text=format_choices(arg['choices'])))
items.append(
nodes.option_list_item(
'',
Expand Down Expand Up @@ -432,9 +434,7 @@ def _format_optional_arguments(self, parser_info):
elif 'choices' not in opt:
opt_items.append(nodes.paragraph(text='Undocumented'))
if 'choices' in opt:
opt_items.append(
nodes.paragraph(text='Possible choices: ' + ', '.join(opt['choices']))
)
opt_items.append(nodes.paragraph(text=format_choices(opt['choices'])))
items.append(
nodes.option_list_item(
'',
Expand Down