Re-add documentation for formatting mypy --help text #19063
Conversation
Fwiw the command line flag conventions at https://github.com/python/mypy/wiki/Documentation-Conventions/b030b2190b84a64928cc8671d23ce199452c5694 look innocuous, feel free to inline them directly into the code
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
| # Tip: try substituting the group title and description into the following sentence: | ||
| # > {group_title}: these flags will {group_description} | ||
| # Feel free to add subsequent sentences that add additional details. | ||
| # 3. If you cannot think of a meaningful description for a new group, omit it entirely. |
There was a problem hiding this comment.
This reads like "feel free to add a group even if it doesn't convey any semantic meaning" which isn't a good advice IMO. Was it intended? Groups are, khm, groups, they are supposed to wrap several settings that have something in common, and that "something" should be easy to describe.
There was a problem hiding this comment.
I have no particular opinion. I suppose this is advice for group for which the programmer cannot think of further description beyond the name.
Never been a problem for me, but I suppose if someone is having trouble it's better to instruct them that the default should be nothing rather than something unhelpful.
|
LG! English isn't my first language so I won't leave an explicit approval for a documentation PR. Let's wait for a native speaker (or someone more confident in their language!) to double-check. |
Fixes #15555
This re-adds some rather-innocuous documentation to main about how to write command line flag descriptions, which were on a wiki page that was subsequently destroyed (rendering the link in the comment dead).