Skip to content

Crossreferences to standard library in mypy docs, part 4 #7685

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

Merged
merged 1 commit into from
Oct 12, 2019

Conversation

hoefling
Copy link
Contributor

Added references to the following documents:

  • generics.rst
  • installed_packages.rst
  • introduction.rst
  • literal_types.rst

This is part of splitting up the changes in #7624 into more readable PRs.

@@ -76,7 +76,7 @@ the setup.py might look like

.. note::

If you use setuptools, you must pass the option ``zip_safe=False`` to
If you use :doc:`setuptools <setuptools:index>`, you must pass the option ``zip_safe=False`` to
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another external library is mentioned here that can be referenced as well.

@@ -8,7 +8,7 @@ annotations are just hints for mypy and don't interfere when running your progra
You run your program with a standard Python interpreter, and the annotations
are treated effectively as comments.

Using the Python 3 function annotation syntax (using the :pep`484` notation) or
Using the Python 3 function annotation syntax (using the :pep:`484` notation) or
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Another error of mine from a previous PR...

>>> List[int]
typing.List[int]
>>> List[int].__bases__
(<class 'list'>, typing.MutableSequence)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@gvanrossum keeping your advice in mind in this code example:

.. code-block:: python
>>> print(type(ss))
<class 'str'>

I have added the code-block directives here as well.

@gvanrossum gvanrossum merged commit a9669fa into python:master Oct 12, 2019
@hoefling hoefling deleted the stdlib-crossref-4 branch October 12, 2019 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants