Skip to content
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
26485fe
bpo-25910: Fixes some redirection links in docs
CuriousLearner Jun 3, 2017
e013f38
bpo-25910: Fixes more redirection links in docs
CuriousLearner Jun 3, 2017
06fa4f3
Minor fixes to links
CuriousLearner Jun 3, 2017
1d99ca4
bpo-25910: Address review comments
CuriousLearner Jun 4, 2017
0f96435
bpo-25910: Address review comments
CuriousLearner Jun 5, 2017
cc1b307
bpo-25910: Minor fix to gettext.rst doc
CuriousLearner Jun 5, 2017
bf9d3f8
bpo-25910: Minor link fix in installing/index.rst doc
CuriousLearner Jun 5, 2017
92f023f
bpo-25910: Fixes redirection issues in whatsnew/* doc
CuriousLearner Jun 5, 2017
32b6617
bpo-25910: Address review commits for url redirections
CuriousLearner Jun 5, 2017
91060c3
bpo-25910: Minor fix for building docs succesfully
CuriousLearner Jun 5, 2017
23cc93c
bpo-25910: Reverts change to not lose git blame on docs
CuriousLearner Dec 2, 2017
79930f2
Merge master into fix-issue25910; resolve conflicts
CuriousLearner Dec 6, 2017
4b3f488
Revert changes that might change git blame
CuriousLearner Dec 6, 2017
2bb0157
Minor fix to bitbucket link
CuriousLearner Dec 6, 2017
b44cc3f
Address review comments
CuriousLearner Dec 13, 2017
3f6c78a
Address review comments
CuriousLearner Dec 16, 2017
3f6344e
Update link label in ssl.rst docs
CuriousLearner Dec 17, 2017
3cd462f
Address review comments
CuriousLearner Jan 7, 2018
a021d33
Merge branch master; resolve conflicts
CuriousLearner Jan 7, 2018
353d5bc
Fix issues in ssl.rst docs
CuriousLearner Jan 17, 2018
ceb3581
bpo-25910: Address review comments
CuriousLearner Jan 19, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions Doc/distributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Key terms
locally.

.. _setuptools: https://setuptools.readthedocs.io/en/latest/
.. _wheel: https://wheel.readthedocs.org
.. _wheel: https://wheel.readthedocs.io/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Okay.


Open source licensing and collaboration
=======================================
Expand Down Expand Up @@ -111,7 +111,7 @@ by invoking the ``pip`` module at the command line::
The Python Packaging User Guide includes more details on the `currently
recommended tools`_.

.. _currently recommended tools: https://packaging.python.org/en/latest/current/#packaging-tool-recommendations
.. _currently recommended tools: https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok


Reading the guide
=================
Expand All @@ -124,11 +124,11 @@ involved in creating a project:
* `Uploading the project to the Python Packaging Index`_

.. _Project structure: \
https://packaging.python.org/en/latest/distributing/
https://packaging.python.org/tutorials/distributing-packages/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

.. _Building and packaging the project: \
https://packaging.python.org/en/latest/distributing/#packaging-your-project
https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

.. _Uploading the project to the Python Packaging Index: \
https://packaging.python.org/en/latest/distributing/#uploading-your-project-to-pypi
https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok



How do I...?
Expand Down Expand Up @@ -160,7 +160,7 @@ Python Packaging User Guide for more information and recommendations.
.. seealso::

`Python Packaging User Guide: Binary Extensions
<https://packaging.python.org/en/latest/extensions>`__
<https://packaging.python.org/guides/packaging-binary-extensions/>`__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok


.. other topics:

Expand Down
2 changes: 1 addition & 1 deletion Doc/distutils/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ very little overhead for build/release/install mechanics.
This guide only covers the basic tools for building and distributing
extensions that are provided as part of this version of Python. Third party
tools offer easier to use and more secure alternatives. Refer to the `quick
recommendations section <https://packaging.python.org/en/latest/current/>`__
recommendations section <https://packaging.python.org/guides/tool-recommendations/>`__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

in the Python Packaging User Guide for more information.

.. toctree::
Expand Down
3 changes: 2 additions & 1 deletion Doc/extending/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ your system setup; details are given in later chapters.
avoid writing C extensions and preserve portability to other implementations.
For example, if your use case is calling C library functions or system calls,
you should consider using the :mod:`ctypes` module or the `cffi
<https://cffi.readthedocs.org>`_ library rather than writing custom C code.
<https://cffi.readthedocs.io/>`_ library rather than writing

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Okay.

custom C code.
These modules let you write Python code to interface with C code and are more
portable between implementations of Python than writing and compiling a C
extension module.
Expand Down
2 changes: 1 addition & 1 deletion Doc/extending/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ approaches to creating C and C++ extensions for Python.

.. seealso::

`Python Packaging User Guide: Binary Extensions <https://packaging.python.org/en/latest/extensions/>`_
`Python Packaging User Guide: Binary Extensions <https://packaging.python.org/guides/packaging-binary-extensions/>`_

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

The Python Packaging User Guide not only covers several available
tools that simplify the creation of binary extensions, but also
discusses the various reasons why creating an extension module may be
Expand Down
2 changes: 1 addition & 1 deletion Doc/faq/general.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ The Python project's infrastructure is located all over the world.
`www.python.org <https://www.python.org>`_ is graciously hosted by `Rackspace
<https://www.rackspace.com>`_, with CDN caching provided by `Fastly
<https://www.fastly.com>`_. `Upfront Systems
<http://www.upfrontsystems.co.za/>`_ hosts `bugs.python.org
<http://www.upfrontsoftware.co.za>`_ hosts `bugs.python.org

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Okay.

<https://bugs.python.org>`_. Many other Python services like `the Wiki
<https://wiki.python.org>`_ are hosted by `Oregon State
University Open Source Lab <https://osuosl.org>`_.
Expand Down
2 changes: 1 addition & 1 deletion Doc/howto/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ favourite beverage and carry on.
If your logging needs are simple, then use the above examples to incorporate
logging into your own scripts, and if you run into problems or don't
understand something, please post a question on the comp.lang.python Usenet
group (available at https://groups.google.com/group/comp.lang.python) and you
group (available at https://groups.google.com/forum/#!forum/comp.lang.python) and you

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

should receive help before too long.

Still here? You can carry on reading the next few sections, which provide a
Expand Down
4 changes: 2 additions & 2 deletions Doc/howto/pyporting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -433,12 +433,12 @@ to make sure everything functions as expected in both versions of Python.
.. _Futurize: http://python-future.org/automatic_conversion.html
.. _importlib: https://docs.python.org/3/library/importlib.html#module-importlib
.. _importlib2: https://pypi.python.org/pypi/importlib2
.. _Modernize: https://python-modernize.readthedocs.org/en/latest/
.. _Modernize: https://python-modernize.readthedocs.io/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

.. _mypy: http://mypy-lang.org/
.. _Porting to Python 3: http://python3porting.com/
.. _Pylint: https://pypi.python.org/pypi/pylint

.. _Python 3 Q & A: https://ncoghlan-devs-python-notes.readthedocs.org/en/latest/python3/questions_and_answers.html
.. _Python 3 Q & A: https://ncoghlan-devs-python-notes.readthedocs.io/en/latest/python3/questions_and_answers.html

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok


.. _pytype: https://github.com/google/pytype
.. _python-future: http://python-future.org/
Expand Down
2 changes: 1 addition & 1 deletion Doc/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ modules and extensions.
This guide only covers the basic tools for building and distributing
extensions that are provided as part of this version of Python. Third party
tools offer easier to use and more secure alternatives. Refer to the `quick
recommendations section <https://packaging.python.org/en/latest/current/>`__
recommendations section <https://packaging.python.org/guides/tool-recommendations/>`__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

in the Python Packaging User Guide for more information.


Expand Down
2 changes: 1 addition & 1 deletion Doc/installing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Key terms
repository of open source licensed packages made available for use by
other Python users.
* the `Python Packaging Authority
<https://www.pypa.io/en/latest/>`__ are the group of
<https://www.pypa.io/>`__ are the group of

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

developers and documentation authors responsible for the maintenance and
evolution of the standard packaging tools and the associated metadata and
file format standards. They maintain a variety of tools, documentation,
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/plistlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ or :class:`datetime.datetime` objects.

.. seealso::

`PList manual page <https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man5/plist.5.html>`_
`PList manual page <https://developer.apple.com/library/content/documentation/Cocoa/Conceptual/PropertyLists/>`_

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

Apple's documentation of the file format.


Expand Down
4 changes: 2 additions & 2 deletions Doc/library/ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -869,7 +869,7 @@ Constants

Whether the OpenSSL library has built-in support for *Next Protocol
Negotiation* as described in the `NPN draft specification

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The link label is now outdated.

<https://tools.ietf.org/html/draft-agl-tls-nextprotoneg>`_. When true,
<https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation >`_. When true,
you can use the :meth:`SSLContext.set_npn_protocols` method to advertise
which protocols you want to support.

Expand Down Expand Up @@ -1502,7 +1502,7 @@ to speed up repeated connections from the same clients.
handshake. It should be a list of strings, like ``['http/1.1', 'spdy/2']``,
ordered by preference. The selection of a protocol will happen during the
handshake, and will play out according to the `NPN draft specification
<https://tools.ietf.org/html/draft-agl-tls-nextprotoneg>`_. After a
<https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation >`_. After a

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ditto

successful handshake, the :meth:`SSLSocket.selected_npn_protocol` method will
return the agreed-upon protocol.

Expand Down
2 changes: 0 additions & 2 deletions Doc/library/statistics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -257,8 +257,6 @@ However, for reading convenience, most of the examples show sorted sequences.
* "Statistics for the Behavioral Sciences", Frederick J Gravetter and
Larry B Wallnau (8th Edition).

* Calculating the `median <https://www.ualberta.ca/~opscan/median.html>`_.

* The `SSMEDIAN
<https://help.gnome.org/users/gnumeric/stable/gnumeric.html#gnumeric-function-SSMEDIAN>`_
function in the Gnome Gnumeric spreadsheet, including `this discussion
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/unittest.mock-examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1008,7 +1008,7 @@ subclass.
True

Sometimes this is inconvenient. For example, `one user
<https://code.google.com/p/mock/issues/detail?id=105>`_ is subclassing mock to
<https://code.google.com/archive/p/mock/issues/105>`_ is subclassing mock to

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

created a `Twisted adaptor
<https://twistedmatrix.com/documents/11.0.0/api/twisted.python.components.html>`_.
Having this applied to attributes too actually causes errors.
Expand Down Expand Up @@ -1254,4 +1254,4 @@ As of version 1.5, the Python testing library `PyHamcrest
<https://pyhamcrest.readthedocs.org/>`_ provides similar functionality,
that may be useful here, in the form of its equality matcher
(`hamcrest.library.integration.match_equality
<https://pyhamcrest.readthedocs.org/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality>`_).
<https://pyhamcrest.readthedocs.io/en/release-1.8/integration/#module-hamcrest.library.integration.match_equality>`_).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

4 changes: 2 additions & 2 deletions Doc/library/wsgiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ for implementing WSGI servers, a demo HTTP server that serves WSGI applications,
and a validation tool that checks WSGI servers and applications for conformance
to the WSGI specification (:pep:`3333`).

See https://wsgi.readthedocs.org/ for more information about WSGI, and links to
tutorials and other resources.
See wsgi.readthedocs.io <https://wsgi.readthedocs.io/>_ for more information about WSGI, and links

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hum, maybe you wanted to write:

`wsgi.readthedocs.io <https://wsgi.readthedocs.io/>`_

missing "`"?

to tutorials and other resources.

.. XXX If you're just trying to write a web application...

Expand Down
2 changes: 1 addition & 1 deletion Doc/using/mac.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ number of standard Unix command line editors, :program:`vim` and
:program:`BBEdit` or :program:`TextWrangler` from Bare Bones Software (see
http://www.barebones.com/products/bbedit/index.html) are good choices, as is
:program:`TextMate` (see https://macromates.com/). Other editors include
:program:`Gvim` (http://macvim.org) and :program:`Aquamacs`
:program:`Gvim` (http://macvim-dev.github.io/macvim/) and :program:`Aquamacs`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

(http://aquamacs.org/).

To run your script from the Terminal window you must make sure that
Expand Down
4 changes: 2 additions & 2 deletions Doc/using/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ System variables, you need non-restricted access to your machine

.. seealso::

https://support.microsoft.com/kb/100843
https://support.microsoft.com/en-us/help/100843/environment-variables-in-windows-nt

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

Environment variables in Windows NT

https://technet.microsoft.com/en-us/library/cc754250.aspx
Expand All @@ -386,7 +386,7 @@ System variables, you need non-restricted access to your machine
https://technet.microsoft.com/en-us/library/cc755104.aspx
The SETX command, for permanently modifying environment variables

https://support.microsoft.com/kb/310519
https://support.microsoft.com/en-us/help/310519/how-to-manage-environment-variables-in-windows-xp

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

How To Manage Environment Variables in Windows XP

https://www.chem.gla.ac.uk/~louis/software/faq/q1.html
Expand Down
4 changes: 2 additions & 2 deletions Doc/whatsnew/2.3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -218,10 +218,10 @@ queen threatens another) and the Knight's Tour (a route that takes a knight to
every square of an $NxN$ chessboard without visiting any square twice).

The idea of generators comes from other programming languages, especially Icon
(https://www.cs.arizona.edu/icon/), where the idea of generators is central. In
(https://www2.cs.arizona.edu/icon/), where the idea of generators is central. In

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please keep the original link. While it's currently a redirection to https://www2.cs.arizona.edu/icon/ we can still find https://www.cs.arizona.edu/icon/ on the site itself, but also on Wikipedia.

Icon, every expression and function call behaves like a generator. One example
from "An Overview of the Icon Programming Language" at
https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks
https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please keep www. www2 is strange.

like::

sentence := "Store it in the neighboring harbor"
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/2.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ this edition of "What's New in Python" links to the bug/patch
item for each change.

Hosting of the Python bug tracker is kindly provided by
`Upfront Systems <http://www.upfrontsystems.co.za/>`__
`Upfront Systems <http://www.upfrontsoftware.co.za>`__

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok

of Stellenbosch, South Africa. Martin von Löwis put a
lot of effort into importing existing bugs and patches from
SourceForge; his scripts for this import operation are at
Expand Down
2 changes: 1 addition & 1 deletion Doc/whatsnew/3.6.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1568,7 +1568,7 @@ mark class variables. As introduced in :pep:`526`, a variable annotation
wrapped in ClassVar indicates that a given attribute is intended to be used as
a class variable and should not be set on instances of that class.
(Contributed by Ivan Levkivskyi in `Github #280
<https://github.com/python/typing/issues/280>`_.)
<https://github.com/python/typing/pull/280>`_.)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

ok


A new :const:`~typing.TYPE_CHECKING` constant that is assumed to be
``True`` by the static type chekers, but is ``False`` at runtime.
Expand Down