Skip to content

Enforce that all flags must have a non-empty help string to prevent undocumented flags and reduce technical debt. #388

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
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enforce that all flags must have a non-empty help string to prevent undocumented flags and reduce technical debt. #388

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
2 changes: 1 addition & 1 deletion absl/flags/_flag.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def __init__(
self.name = name

if not help_string:
help_string = '(no help available)'
raise ValueError(f'Flag --{name} MUST have a non-empty help string. Undocumented flags are technical debt.')

self.help = help_string
self.short_name = short_name
Expand Down
Loading