Skip to content

Commit 49d469d

Browse files
format style guide more nicely
1 parent cd3b6d0 commit 49d469d

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

mypy/main.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -535,17 +535,16 @@ def add_invertible_flag(
535535
# their `dest` prefixed with `special-opts:`, which will cause them to be
536536
# parsed into the separate special_opts namespace object.
537537

538-
# Note: we have a style guide for formatting the mypy --help text:
539-
# # Command line flag conventions
540-
# This section documents our style guide for formatting the output of running `mypy --help`.
541-
# ## Flags
538+
# Our style guide for formatting the output of running `mypy --help`:
539+
# Flags:
542540
# 1. The flag help text should start with a capital letter but never end with a period.
543541
# 2. Keep the flag help text brief -- ideally just a single sentence.
544542
# 3. All flags must be a part of a group, unless the flag is deprecated or suppressed.
545543
# 4. Avoid adding new flags to the "miscellaneous" groups -- instead add them to an
546544
# existing group or, if applicable, create a new group. Feel free to move existing
547545
# flags to a new group: just be sure to also update the documentation to match.
548-
# ## Groups
546+
#
547+
# Groups:
549548
# 1. The group title and description should start with a capital letter.
550549
# 2. The first sentence of a group description should be written in the imperative mood.
551550
# Tip: try substituting the group title and description into the following sentence:

0 commit comments

Comments
 (0)