Skip to content

Update to config file doc to match command line doc and --help #7776

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
Merged
merged 35 commits into from
Oct 23, 2019
Merged

Update to config file doc to match command line doc and --help #7776

merged 35 commits into from
Oct 23, 2019

Conversation

@jolaf
Copy link
Contributor

@jolaf jolaf commented Oct 22, 2019 •
edited
Loading

Fixes #7574, #7575, #7772, #7775.

jolaf added 16 commits October 21, 2019 05:02
@jolaf
Preparing to restructure the document to removing the separation of o…
394b71c 
…ptions to "Per-module and global" and "Global only" options in the config file doc.
@jolaf
Merging "Import discovery" sections
6dfb4c2
@jolaf
Reordering sections: moving Examples to the end of the preface part.
e25668b
@jolaf
Fixing broken links.
4937647
@jolaf
Reordering options and sections to match the command line doc
9e9ab74
@jolaf
Old typo fixed (Optional should be written with capital O)
2b0c505
@jolaf
Removed new_semantic_analyzer option that is now obsolete as the old …
8b5cff1 
…semantic analyzer support is removed
@jolaf
Unifying section separators
7480ff4
@jolaf
Note formatting fixed
8f3a33c
@jolaf
Added allow_untyped_globals description from command line doc
525a25a
@jolaf
"Advanced flags" section renamed to "Advanced options" to match the c…
1e55ebc 
…onfig file documentation
@jolaf
Copied "Report generation" section from command line documentation
7132a2d
@jolaf
Added options mentioned in --help but lacking documentation
f9b2dbb
@jolaf
Minor description correction
0fb3f98
@jolaf
Added options that are mentioned in --help but were otherwise undoc…
d2e738f 
…umented
@jolaf
Minor formatting fix
72f1564
@jolaf jolaf mentioned this pull request Oct 22, 2019
Closed
@jolaf jolaf mentioned this pull request Oct 22, 2019
Closed
msullivan
msullivan reviewed Oct 22, 2019
View reviewed changes
Copy link
Collaborator

@msullivan msullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, but has some TBD's that need to be filled in.

lineprecision-report produces a flat text file report with per-module counts about how many lines are typechecked/have no anys/etc.
memory-xml-report is a base class that doesn't do anything by its own and should probably not be part of the documentation or an option??
xml-report Generates an XML report? But it is like a viewable report using XSLT? I'm not totally sure how this is supposed to differ.

IDK our reporting is all a mess tbh

Michael0x2a
Michael0x2a reviewed Oct 22, 2019
View reviewed changes
@Michael0x2a Michael0x2a merged commit 09c1fc7 into python:master Oct 23, 2019
@Michael0x2a
Copy link
Collaborator

Michael0x2a commented Oct 23, 2019

Looks good now, thanks!

@jolaf jolaf deleted the options-doc branch October 23, 2019 20:53
@jolaf jolaf mentioned this pull request Oct 23, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@msullivan msullivan msullivan left review comments

@Michael0x2a Michael0x2a Michael0x2a left review comments

@ilevkivskyi ilevkivskyi ilevkivskyi left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Command line documentation differs from --help

4 participants

@jolaf @Michael0x2a @msullivan @ilevkivskyi