8000 Missing documentation for formatting `mypy --help` text · Issue #15555 · python/mypy · GitHub
[go: up one dir, main page]
Skip to content

Missing documentation for formatting mypy --help text #15555

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

Jump to bottom
Closed
ykrx opened this issue Jun 30, 2023 · 2 comments · Fixed by #19063
Closed

Missing documentation for formatting mypy --help text #15555

ykrx opened this issue Jun 30, 2023 · 2 comments · Fixed by #19063
Labels
documentation topic-developer Issues relevant to mypy developers

Comments

@ykrx
Copy link
ykrx commented Jun 30, 2023

Documentation

Comment at mypy/main.py#L503C5-L503C5 references missing documentation.
@AlexWaygood AlexWaygood added the topic-developer Issues relevant to mypy developers label Jun 30, 2023
@wyattscarpenter
Copy link
Contributor
wyattscarpenter commented May 9, 2025 •
edited
Loading

Checking the git history for the wiki, it seems this page used to exist ( https://github.com/python/mypy/wiki/Documentation-Conventions/b030b2190b84a64928cc8671d23ce199452c5694 ) but seems to have been deliberately deleted in 2021 by @hauntsaninja for whatever reason:

commit 0c533026a08ec6989edeb8b93121117397f03f05
Author: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Date:   Sat Oct 30 22:13:47 2021 -0700

    Destroyed Documentation Conventions (markdown)

I'm not familiar with the history of the wiki and its decisions. I guess the reference to this document in the comment can be deleted, or else maybe the document should be recreated.

@hauntsaninja
Copy link
Collaborator

I don't remember, sorry. 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

wyattscarpenter added a commit to wyattscarpenter/mypy that referenced this issue May 9, 2025
@wyattscarpenter
fix python#15555
67274d2 
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
@wyattscarpenter wyattscarpenter mentioned this issue May 9, 2025
Merged
hauntsaninja pushed a commit that referenced this issue May 10, 2025
@wyattscarpenter
Re-add documentation for formatting mypy --help text (#19063)
18a6695 
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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation topic-developer Issues relevant to mypy developers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Re-add documentation for formatting mypy --help text wyattscarpenter/mypy
4 participants
@hauntsaninja @wyattscarpenter @ykrx @AlexWaygood
0