Various documentation updates #5043
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This includes a bunch of updates to the documentation, including (but not limited to) these: * Remove or update some obsolete things * Make the ordering within some sections more logical * Clarify some explanations * Add some cross references and links
msullivan
approved these changes
May 14, 2018
docs/source/introduction.rst
Outdated
| Mypy is still experimental. There will be changes | ||
| that break backward compatibility. | ||
| Mypy is used in production by many companies and projects, but mypy is | ||
| officially alpha software. There will be occasional changes |
docs/source/python2.rst
Outdated
| @@ -120,10 +120,11 @@ Additional notes | |||
| - The annotation can be on the same line as the function header or on | |||
| the following line. | |||
|
|
|||
| - The type syntax for variables is the same as for Python 3. | |||
| - Use the same comment-based type syntax for variables as in Python 3 | |||
| versions earlier than 3.6 (this is explained later in this document). | |||
There was a problem hiding this comment.
This is kind of clunky sounding?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This includes a bunch of updates to the documentation, including
(but not limited to) these: