Skip to content
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.

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

Reorganize mypy documentation into sections #5104

Merged
merged 1 commit into from May 24, 2018

Conversation

Projects
None yet
3 participants
@Michael0x2a
Copy link
Collaborator

Michael0x2a commented May 24, 2018

This pull request reorganizes the documentation into different sections. This change should hopefully:

  1. Make it a little easier for new users to navigate the docs.
  2. Make the nav sidebar feel a little less overwhelming.
  3. Make it more obvious which parts of the documentation are about type
    hint semantics vs which are about specifically mypy.

This pull request also retitled the cheat sheets: the phrase "mypy syntax" didn't feel quite accurate to me.

Reorganize mypy documentation into sections
This commit reorganizes the documentation into different sections. This
change should hopefully:

1.  Make it a little easier for new users to navigate the docs.
2.  Make the nav sidebar feel a little less overwhelming.
3.  Make it more obvious which parts of the documentation are about type
    hint semantics vs which are about specifically mypy.

This commit also retitled the cheat sheets: the phrase "mypy syntax"
didn't feel quite accurate to me.

@Michael0x2a Michael0x2a force-pushed the Michael0x2a:add-sections-to-docs branch from 2b0955c to 93b3932 May 24, 2018

@Michael0x2a

This comment has been minimized.

Copy link
Collaborator Author

Michael0x2a commented May 24, 2018

Also, I uploaded a (temporary) build of this branch to Read the Docs if anybody wants to quickly see what it looks like. The only real changes are to the index page and the nav.

@msullivan
Copy link
Collaborator

msullivan left a comment

This is great! The sections make it much less wall of text.

@gvanrossum gvanrossum merged commit 464b553 into python:master May 24, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@gvanrossum

This comment has been minimized.

Copy link
Member

gvanrossum commented May 24, 2018

Thanks! This reminds me -- we need a section on Python 3.7 features.

@Michael0x2a Michael0x2a deleted the Michael0x2a:add-sections-to-docs branch Jul 9, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.