From 26485fe40ea60fe66cd1ef865a698b086ca7f0eb Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Sat, 3 Jun 2017 17:30:14 +0530 Subject: [PATCH 01/19] bpo-25910: Fixes some redirection links in docs --- Doc/about.rst | 2 +- Doc/bugs.rst | 2 +- Doc/distributing/index.rst | 10 +++++----- Doc/distutils/index.rst | 2 +- Doc/extending/extending.rst | 3 ++- Doc/extending/index.rst | 2 +- Doc/faq/design.rst | 4 ++-- Doc/faq/extending.rst | 4 ++-- Doc/faq/general.rst | 14 +++++++------- Doc/faq/gui.rst | 8 ++++---- Doc/faq/library.rst | 4 ++-- Doc/faq/programming.rst | 5 +++-- Doc/faq/windows.rst | 6 +++--- Doc/glossary.rst | 2 +- 14 files changed, 35 insertions(+), 33 deletions(-) diff --git a/Doc/about.rst b/Doc/about.rst index 3ea311fa629dd2..57acdfb6f42278 100644 --- a/Doc/about.rst +++ b/Doc/about.rst @@ -7,7 +7,7 @@ These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a document processor specifically written for the Python documentation. .. _reStructuredText: http://docutils.sourceforge.net/rst.html -.. _Sphinx: http://sphinx-doc.org/ +.. _Sphinx: http://www.sphinx-doc.org/en/stable/ .. In the online version of these documents, you can submit comments and suggest changes directly on the documentation pages. diff --git a/Doc/bugs.rst b/Doc/bugs.rst index 1b0a5a9a9377cb..739bd2fc8c39ce 100644 --- a/Doc/bugs.rst +++ b/Doc/bugs.rst @@ -68,7 +68,7 @@ taken on the bug. .. seealso:: - `How to Report Bugs Effectively `_ + `How to Report Bugs Effectively `_ Article which goes into some detail about how to create a useful bug report. This describes what kind of information is useful and why it is useful. diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 82ecd2c1ef45fb..8811da4dc17281 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -35,7 +35,7 @@ Key terms repository of open source licensed packages made available for use by other Python users * the `Python Packaging Authority - `__ are the group of + `__ are the group of 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 @@ -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/current/#packaging-tool-recommendations Reading the guide ================= @@ -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/distributing/ .. _Building and packaging the project: \ - https://packaging.python.org/en/latest/distributing/#packaging-your-project + https://packaging.python.org/distributing/#packaging-your-project .. _Uploading the project to the Python Packaging Index: \ - https://packaging.python.org/en/latest/distributing/#uploading-your-project-to-pypi + https://packaging.python.org/distributing/#uploading-your-project-to-pypi How do I...? diff --git a/Doc/distutils/index.rst b/Doc/distutils/index.rst index c565bcc5628624..847208597fd9e8 100644 --- a/Doc/distutils/index.rst +++ b/Doc/distutils/index.rst @@ -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 `__ + recommendations section `__ in the Python Packaging User Guide for more information. .. toctree:: diff --git a/Doc/extending/extending.rst b/Doc/extending/extending.rst index 2dc20fed131d07..356f421e571601 100644 --- a/Doc/extending/extending.rst +++ b/Doc/extending/extending.rst @@ -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 - `_ library rather than writing custom C code. + `_ library rather than writing + 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. diff --git a/Doc/extending/index.rst b/Doc/extending/index.rst index 9eec8c273af301..021e2977fc9f92 100644 --- a/Doc/extending/index.rst +++ b/Doc/extending/index.rst @@ -32,7 +32,7 @@ approaches to creating C and C++ extensions for Python. .. seealso:: - `Python Packaging User Guide: Binary Extensions `_ + `Python Packaging User Guide: Binary Extensions `_ 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 diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index 1bd800b1a81bab..a1861901bc155b 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -343,7 +343,7 @@ each Python stack frame. Also, extensions can call back into Python at almost random moments. Therefore, a complete threads implementation requires thread support for C. -Answer 2: Fortunately, there is `Stackless Python `_, +Answer 2: Fortunately, there is `Stackless Python `_, which has a completely redesigned interpreter loop that avoids the C stack. @@ -370,7 +370,7 @@ Can Python be compiled to machine code, C or some other language? optional annotations into C extensions. `Nuitka `_ is an up-and-coming compiler of Python into C++ code, aiming to support the full Python language. For compiling to Java you can consider -`VOC `_. +`VOC `_. How does Python manage memory? diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst index 3eafdf193c80a4..88420c2fd35b76 100644 --- a/Doc/faq/extending.rst +++ b/Doc/faq/extending.rst @@ -52,8 +52,8 @@ currently exists, you can try wrapping the library's data types and functions with a tool such as `SWIG `_. `SIP `__, `CXX `_ `Boost -`_, or `Weave -`_ are also +`_, or +`Weave`_ are also alternatives for wrapping C++ libraries. diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index 8f6a907a8a2fda..6483d8a100545d 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -53,7 +53,7 @@ commercial use, to sell copies of Python in source or binary form (modified or unmodified), or to sell products that incorporate Python in some form. We would still like to know about all commercial use of Python, of course. -See `the PSF license page `_ to find further +See `the PSF license page `_ to find further explanations and a link to the full text of the license. The Python logo is trademarked, and in certain cases permission is required to @@ -181,7 +181,7 @@ at https://docs.python.org/3/. PDF, plain text, and downloadable HTML versions also available at https://docs.python.org/3/download.html. The documentation is written in reStructuredText and processed by `the Sphinx -documentation tool `__. The reStructuredText source for +documentation tool `__. The reStructuredText source for the documentation is part of the Python source distribution. @@ -272,7 +272,7 @@ The Python project's infrastructure is located all over the world. `www.python.org `_ is graciously hosted by `Rackspace `_, with CDN caching provided by `Fastly `_. `Upfront Systems -`_ hosts `bugs.python.org +`_ hosts `bugs.python.org `_. Many other Python services like `the Wiki `_ are hosted by `Oregon State University Open Source Lab `_. @@ -343,10 +343,10 @@ different companies and organizations. High-profile Python projects include `the Mailman mailing list manager `_ and `the Zope application server -`_. Several Linux distributions, most notably `Red Hat -`_, have written part or all of their installer and -system administration software in Python. Companies that use Python internally -include Google, Yahoo, and Lucasfilm Ltd. +`_. Several Linux distributions, most +notably `Red Hat`_, have written part or all of +their installer and system administration software in Python. Companies +that use Python internally include Google, Yahoo, and Lucasfilm Ltd. What new developments are expected for Python in the future? diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index 477d8c633438d1..927229ce119e83 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -43,7 +43,7 @@ number of platforms, with Windows, Mac OS X, GTK, X11, all listed as current stable targets. Language bindings are available for a number of languages including Python, Perl, Ruby, etc. -wxPython (http://www.wxpython.org) is the Python binding for +wxPython (https://www.wxpython.org/) is the Python binding for wxwidgets. While it often lags slightly behind the official wxWidgets releases, it also offers a number of features via pure Python extensions that are not available in other language bindings. There @@ -72,9 +72,9 @@ Gtk+ The `GObject introspection bindings `_ for Python allow you to write GTK+ 3 applications. There is also a -`Python GTK+ 3 Tutorial `_. +`Python GTK+ 3 Tutorial `_. -The older PyGtk bindings for the `Gtk+ 2 toolkit `_ have +The older PyGtk bindings for the `Gtk+ 2 toolkit `_ have been implemented by James Henstridge; see . Kivy @@ -90,7 +90,7 @@ Kivy is free and open source software distributed under the MIT license. FLTK ---- -Python bindings for `the FLTK toolkit `_, a simple yet +Python bindings for `the FLTK toolkit `_, a simple yet powerful and mature cross-platform windowing system, are available from `the PyFLTK project `_. diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst index b5fdfa42cdb082..00d3e325692005 100644 --- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -182,7 +182,7 @@ How do I create documentation from doc strings? The :mod:`pydoc` module can create HTML from the doc strings in your Python source code. An alternative for creating API documentation purely from docstrings is `epydoc `_. `Sphinx -`_ can also include docstring content. +`_ can also include docstring content. How do I get a single keypress at a time? @@ -419,7 +419,7 @@ Python program effectively only uses one CPU, due to the insistence that Back in the days of Python 1.5, Greg Stein actually implemented a comprehensive patch set (the "free threading" patches) that removed the GIL and replaced it with fine-grained locking. Adam Olsen recently did a similar experiment -in his `python-safethread `_ +in his `python-safethread `_ project. Unfortunately, both experiments exhibited a sharp drop in single-thread performance (at least 30% slower), due to the amount of fine-grained locking necessary to compensate for the removal of the GIL. diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index d9bdb21e79ac66..f2fa0b786cf620 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -69,7 +69,8 @@ plug-ins to add a custom feature. In addition to the bug checking that PyChecker performs, Pylint offers some additional features such as checking line length, whether variable names are well-formed according to your coding standard, whether declared interfaces are fully implemented, and more. -https://docs.pylint.org/ provides a full list of Pylint's features. +https://pylint.readthedocs.io/en/latest/ provides a full list of Pylint's +features. How can I create a stand-alone binary from a Python script? @@ -100,7 +101,7 @@ which don't. One is Thomas Heller's py2exe (Windows only) at http://www.py2exe.org/ -Another tool is Anthony Tuininga's `cx_Freeze `_. +Another tool is Anthony Tuininga's `cx_Freeze `_. Are there coding standards or a style guide for Python programs? diff --git a/Doc/faq/windows.rst b/Doc/faq/windows.rst index 6ac83e45d2e815..fcb211f4a47a98 100644 --- a/Doc/faq/windows.rst +++ b/Doc/faq/windows.rst @@ -170,8 +170,8 @@ offender. How do I make an executable from a Python script? ------------------------------------------------- -See http://cx-freeze.sourceforge.net/ for a distutils extension that allows you -to create console and GUI executables from Python code. +See https://anthony-tuininga.github.io/cx_Freeze/ for a distutils extension +that allows you to create console and GUI executables from Python code. `py2exe `_, the most popular extension for building Python 2.x-based executables, does not yet support Python 3 but a version that does is in development. @@ -341,5 +341,5 @@ This is a mistake; the extension should be .TGZ. Simply rename the downloaded file to have the .TGZ extension, and WinZip will be able to handle it. (If your copy of WinZip doesn't, get a newer one from -https://www.winzip.com.) +http://www.winzip.com/win/en/.) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index dba9186d935a6a..c4468a3943d4ec 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -126,7 +126,7 @@ Glossary BDFL Benevolent Dictator For Life, a.k.a. `Guido van Rossum - `_, Python's creator. + `_, Python's creator. binary file A :term:`file object` able to read and write From e013f389ff0247aca01e3c6f6080dc69d86cd08a Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Sat, 3 Jun 2017 22:44:45 +0530 Subject: [PATCH 02/19] bpo-25910: Fixes more redirection links in docs --- Doc/distributing/index.rst | 4 ++-- Doc/faq/extending.rst | 4 ++-- Doc/howto/curses.rst | 4 ++-- Doc/howto/logging.rst | 2 +- Doc/howto/pyporting.rst | 6 +++--- Doc/howto/unicode.rst | 4 ++-- Doc/install/index.rst | 2 +- Doc/library/ast.rst | 5 +++-- Doc/library/distutils.rst | 2 +- Doc/library/email.generator.rst | 4 ++-- Doc/library/gettext.rst | 2 +- Doc/library/hashlib.rst | 4 ++-- Doc/library/http.client.rst | 2 +- Doc/library/othergui.rst | 6 +++--- Doc/library/plistlib.rst | 2 +- Doc/library/secrets.rst | 4 ++-- Doc/library/select.rst | 2 +- Doc/library/smtpd.rst | 7 ++++--- Doc/library/sqlite3.rst | 2 +- Doc/library/ssl.rst | 6 +++--- Doc/library/statistics.rst | 2 +- Doc/library/tkinter.rst | 4 ++-- Doc/library/trace.rst | 2 +- Doc/library/unittest.mock-examples.rst | 4 ++-- Doc/library/unittest.rst | 2 +- Doc/library/urllib.request.rst | 2 +- Doc/library/wsgiref.rst | 4 ++-- Doc/tutorial/interactive.rst | 2 +- Doc/tutorial/whatnow.rst | 2 +- Doc/using/mac.rst | 6 +++--- Doc/using/windows.rst | 18 +++++++++--------- 31 files changed, 62 insertions(+), 60 deletions(-) diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 8811da4dc17281..3004d330b9efa7 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -62,7 +62,7 @@ Key terms locally. .. _setuptools: https://setuptools.readthedocs.io/en/latest/ -.. _wheel: https://wheel.readthedocs.org +.. _wheel: https://wheel.readthedocs.io/en/latest/ Open source licensing and collaboration ======================================= @@ -160,7 +160,7 @@ Python Packaging User Guide for more information and recommendations. .. seealso:: `Python Packaging User Guide: Binary Extensions - `__ + `__ .. other topics: diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst index 88420c2fd35b76..d1e687f69d35ef 100644 --- a/Doc/faq/extending.rst +++ b/Doc/faq/extending.rst @@ -53,7 +53,7 @@ with a tool such as `SWIG `_. `SIP `__, `CXX `_ `Boost `_, or -`Weave`_ are also +`Weave `_ are also alternatives for wrapping C++ libraries. @@ -440,6 +440,6 @@ Can I create an object class with some methods implemented in C and others in Py Yes, you can inherit from built-in classes such as :class:`int`, :class:`list`, :class:`dict`, etc. -The Boost Python Library (BPL, http://www.boost.org/libs/python/doc/index.html) +The Boost Python Library (BPL, http://www.boost.org/doc/libs/1_64_0/libs/python/doc/html/index.html) provides a way of doing this from C++ (i.e. you can inherit from an extension class written in C++ using the BPL). diff --git a/Doc/howto/curses.rst b/Doc/howto/curses.rst index 188a5cf2231b87..9b4e9e299aea38 100644 --- a/Doc/howto/curses.rst +++ b/Doc/howto/curses.rst @@ -543,10 +543,10 @@ learn more about submitting patches to Python. * `Writing Programs with NCURSES `_: a lengthy tutorial for C programmers. -* `The ncurses man page `_ +* `The ncurses man page `_ * `The ncurses FAQ `_ * `"Use curses... don't swear" `_: video of a PyCon 2013 talk on controlling terminals using curses or Urwid. -* `"Console Applications with Urwid" `_: +* `"Console Applications with Urwid" `_: video of a PyCon CA 2012 talk demonstrating some applications written using Urwid. diff --git a/Doc/howto/logging.rst b/Doc/howto/logging.rst index 8074b0f10997d5..4ee68b4747eb00 100644 --- a/Doc/howto/logging.rst +++ b/Doc/howto/logging.rst @@ -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 should receive help before too long. Still here? You can carry on reading the next few sections, which provide a diff --git a/Doc/howto/pyporting.rst b/Doc/howto/pyporting.rst index 8562d2373749f0..3911aa115152f8 100644 --- a/Doc/howto/pyporting.rst +++ b/Doc/howto/pyporting.rst @@ -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/en/latest/ .. _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 .. _pytype: https://github.com/google/pytype .. _python-future: http://python-future.org/ @@ -449,4 +449,4 @@ to make sure everything functions as expected in both versions of Python. .. _"What's New": https://docs.python.org/3/whatsnew/index.html -.. _Why Python 3 exists: http://www.snarky.ca/why-python-3-exists +.. _Why Python 3 exists: https://snarky.ca/why-python-3-exists/ diff --git a/Doc/howto/unicode.rst b/Doc/howto/unicode.rst index 9649b9c609c255..a83e5a21895c2a 100644 --- a/Doc/howto/unicode.rst +++ b/Doc/howto/unicode.rst @@ -217,7 +217,7 @@ To help understand the standard, Jukka Korpela has written `an introductory guide `_ to reading the Unicode character tables. -Another `good introductory article `_ +Another `good introductory article `_ was written by Joel Spolsky. If this introduction didn't make things clear to you, you should try reading this alternate article before continuing. @@ -487,7 +487,7 @@ References Some good alternative discussions of Python's Unicode support are: * `Processing Text Files in Python 3 `_, by Nick Coghlan. -* `Pragmatic Unicode `_, a PyCon 2012 presentation by Ned Batchelder. +* `Pragmatic Unicode `_, a PyCon 2012 presentation by Ned Batchelder. The :class:`str` type is described in the Python library reference at :ref:`textseq`. diff --git a/Doc/install/index.rst b/Doc/install/index.rst index bc080b00c59a82..8b593431b71953 100644 --- a/Doc/install/index.rst +++ b/Doc/install/index.rst @@ -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 `__ + recommendations section `__ in the Python Packaging User Guide for more information. diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst index bda46f46c43667..5236b84f394e17 100644 --- a/Doc/library/ast.rst +++ b/Doc/library/ast.rst @@ -261,5 +261,6 @@ and classes for traversing abstract syntax trees: .. seealso:: - `Green Tree Snakes `_, an external documentation resource, has good - details on working with Python ASTs. + `Green Tree Snakes `_, + an external documentation resource, has good details on working with + Python ASTs. diff --git a/Doc/library/distutils.rst b/Doc/library/distutils.rst index 62abc85ac397a4..44751fc5b1e856 100644 --- a/Doc/library/distutils.rst +++ b/Doc/library/distutils.rst @@ -29,7 +29,7 @@ enhanced alternative to :mod:`distutils` that provides: installation time rather than needing to prebuild them * consistent behaviour across all supported Python versions -The recommended `pip `__ installer runs all +The recommended `pip `__ installer runs all ``setup.py`` scripts with ``setuptools``, even if the script itself only imports ``distutils``. Refer to the `Python Packaging User Guide `_ for more diff --git a/Doc/library/email.generator.rst b/Doc/library/email.generator.rst index 1e64e1066c7da5..cc8e8225a203ab 100644 --- a/Doc/library/email.generator.rst +++ b/Doc/library/email.generator.rst @@ -53,7 +53,7 @@ over channels that are not "8 bit clean". :data:`~email.policy.compat32` policy and ``False`` for all others). *mangle_from_* is intended for use when messages are stored in unix mbox format (see :mod:`mailbox` and `WHY THE CONTENT-LENGTH FORMAT IS BAD - `_). + `_). If *maxheaderlen* is not ``None``, refold any header lines that are longer than *maxheaderlen*, or if ``0``, do not rewrap any headers. If @@ -154,7 +154,7 @@ to be using :class:`BytesGenerator`, and not :class:`Generator`. :data:`~email.policy.compat32` policy and ``False`` for all others). *mangle_from_* is intended for use when messages are stored in unix mbox format (see :mod:`mailbox` and `WHY THE CONTENT-LENGTH FORMAT IS BAD - `_). + `_). If *maxheaderlen* is not ``None``, refold any header lines that are longer than *maxheaderlen*, or if ``0``, do not rewrap any headers. If diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst index 3a87bf591776c4..a986f474236e99 100644 --- a/Doc/library/gettext.rst +++ b/Doc/library/gettext.rst @@ -457,7 +457,7 @@ There are a few tools to extract the strings meant for translation. The original GNU :program:`gettext` only supported C or C++ source code but its extended version :program:`xgettext` scans code written in a number of languages, including Python, to find strings marked as -translatable. `Babel `__ is a Python +translatable. `Babel `__ is a Python internationalization library that includes a :file:`pybabel` script to extract and compile message catalogs. François Pinard's program called :program:`xpot` does a similar job and is available as part of diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst index 9d563566d49d7f..d789884f6d6e6f 100644 --- a/Doc/library/hashlib.rst +++ b/Doc/library/hashlib.rst @@ -482,7 +482,7 @@ Keyed hashing Keyed hashing can be used for authentication as a faster and simpler replacement for `Hash-based message authentication code -`_ (HMAC). +`_ (HMAC). BLAKE2 can be securely used in prefix-MAC mode thanks to the indifferentiability property inherited from BLAKE. @@ -694,7 +694,7 @@ implementation, extension code, and this documentation: You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see - http://creativecommons.org/publicdomain/zero/1.0/. + https://creativecommons.org/publicdomain/zero/1.0/. The following people have helped with development or contributed their changes to the project and the public domain according to the Creative Commons Public diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index 53de40f63ca471..6c40203607396e 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -20,7 +20,7 @@ HTTPS protocols. It is normally not used directly --- the module .. seealso:: - The `Requests package `_ + The `Requests package `_ is recommended for a higher-level HTTP client interface. .. note:: diff --git a/Doc/library/othergui.rst b/Doc/library/othergui.rst index d40abe167653b7..fcc7c4251a0d34 100644 --- a/Doc/library/othergui.rst +++ b/Doc/library/othergui.rst @@ -11,9 +11,9 @@ available for Python: `PyGObject `_ PyGObject provides introspection bindings for C libraries using `GObject `_. One of - these libraries is the `GTK+ 3 `_ widget set. + these libraries is the `GTK+ 3 `_ widget set. GTK+ comes with many more widgets than Tkinter provides. An online - `Python GTK+ 3 Tutorial `_ + `Python GTK+ 3 Tutorial `_ is available. `PyGTK `_ @@ -35,7 +35,7 @@ available for Python: Compared to PyQt, its licensing scheme is friendlier to non-open source applications. - `wxPython `_ + `wxPython `_ wxPython is a cross-platform GUI toolkit for Python that is built around the popular `wxWidgets `_ (formerly wxWindows) C++ toolkit. It provides a native look and feel for applications on diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index 7d306a2bcaf11c..a75f961b959995 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -38,7 +38,7 @@ or :class:`datetime.datetime` objects. .. seealso:: - `PList manual page `_ + `PList manual page < https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/plist.5.html>`_ Apple's documentation of the file format. diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst index 9bf848f9114359..28ce472c7e7e16 100644 --- a/Doc/library/secrets.rst +++ b/Doc/library/secrets.rst @@ -130,7 +130,7 @@ Other functions Return ``True`` if strings *a* and *b* are equal, otherwise ``False``, in such a way as to reduce the risk of - `timing attacks `_. + `timing attacks `_. See :func:`hmac.compare_digest` for additional details. @@ -173,7 +173,7 @@ three digits: break -Generate an `XKCD-style passphrase `_: +Generate an `XKCD-style passphrase `_: .. testcode:: diff --git a/Doc/library/select.rst b/Doc/library/select.rst index bd5442c6a27aa0..e252e7adb9246a 100644 --- a/Doc/library/select.rst +++ b/Doc/library/select.rst @@ -264,7 +264,7 @@ object. Edge and Level Trigger Polling (epoll) Objects ---------------------------------------------- - http://linux.die.net/man/4/epoll + https://linux.die.net/man/4/epoll *eventmask* diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst index 85ee8a75cf77a9..beefb34fd8116d 100644 --- a/Doc/library/smtpd.rst +++ b/Doc/library/smtpd.rst @@ -15,9 +15,10 @@ This module offers several classes to implement SMTP (email) servers. .. seealso:: - The `aiosmtpd `_ package is a recommended - replacement for this module. It is based on :mod:`asyncio` and provides a - more straightforward API. :mod:`smtpd` should be considered deprecated. + The `aiosmtpd `_ package is a + recommended replacement for this module. It is based on :mod:`asyncio` + and provides a more straightforward API. :mod:`smtpd` should be + considered deprecated. Several server implementations are present; one is a generic do-nothing implementation, which can be overridden, while the other two offer diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst index 9fef7d7f03f1f0..20e65347d4d33c 100644 --- a/Doc/library/sqlite3.rst +++ b/Doc/library/sqlite3.rst @@ -107,7 +107,7 @@ This example uses the iterator form:: The SQLite web page; the documentation describes the syntax and the available data types for the supported SQL dialect. - http://www.w3schools.com/sql/ + https://www.w3schools.com/sql/ Tutorial, reference and examples for learning SQL syntax. :pep:`249` - Database API Specification 2.0 diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 6deaded0d6effd..aa45bc82a31e4e 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -832,7 +832,7 @@ Constants Whether the OpenSSL library has built-in support for *Next Protocol Negotiation* as described in the `NPN draft specification - `_. When true, + `_. When true, you can use the :meth:`SSLContext.set_npn_protocols` method to advertise which protocols you want to support. @@ -1458,7 +1458,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 - `_. After a + `_. After a successful handshake, the :meth:`SSLSocket.selected_npn_protocol` method will return the agreed-upon protocol. @@ -1546,7 +1546,7 @@ to speed up repeated connections from the same clients. .. versionadded:: 3.3 .. seealso:: - `SSL/TLS & Perfect Forward Secrecy `_ + `SSL/TLS & Perfect Forward Secrecy `_ Vincent Bernat. .. method:: SSLContext.wrap_socket(sock, server_side=False, \ diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index 2aa778c4d06deb..f7bc7dfd0a0b33 100644 --- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -257,7 +257,7 @@ 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 `_. + * Calculating the `median `_. * The `SSMEDIAN `_ diff --git a/Doc/library/tkinter.rst b/Doc/library/tkinter.rst index 3e1faed8c7b8d5..35e7a5fb90567a 100644 --- a/Doc/library/tkinter.rst +++ b/Doc/library/tkinter.rst @@ -38,7 +38,7 @@ this should open a window demonstrating a simple Tk interface. `Programming Python `_ Book by Mark Lutz, has excellent coverage of Tkinter. - `Modern Tkinter for Busy Python Developers `_ + `Modern Tkinter for Busy Python Developers `_ Book by Mark Rozerman about building attractive and modern graphical user interfaces with Python and Tkinter. `Python and Tkinter Programming `_ @@ -183,7 +183,7 @@ documentation that exists. Here are some hints: `ActiveState Tcl Home Page `_ The Tk/Tcl development is largely taking place at ActiveState. - `Tcl and the Tk Toolkit `_ + `Tcl and the Tk Toolkit `_ The book by John Ousterhout, the inventor of Tcl. `Practical Programming in Tcl and Tk `_ diff --git a/Doc/library/trace.rst b/Doc/library/trace.rst index 5cb7029adf5e9e..2eed748c6347a2 100644 --- a/Doc/library/trace.rst +++ b/Doc/library/trace.rst @@ -15,7 +15,7 @@ or from the command line. .. seealso:: - `Coverage.py `_ + `Coverage.py `_ A popular third-party coverage tool that provides HTML output along with advanced features such as branch coverage. diff --git a/Doc/library/unittest.mock-examples.rst b/Doc/library/unittest.mock-examples.rst index 05f33740d7527a..20f35c2f8cab50 100644 --- a/Doc/library/unittest.mock-examples.rst +++ b/Doc/library/unittest.mock-examples.rst @@ -1008,7 +1008,7 @@ subclass. True Sometimes this is inconvenient. For example, `one user -`_ is subclassing mock to +`_ is subclassing mock to created a `Twisted adaptor `_. Having this applied to attributes too actually causes errors. @@ -1254,4 +1254,4 @@ As of version 1.5, the Python testing library `PyHamcrest `_ provides similar functionality, that may be useful here, in the form of its equality matcher (`hamcrest.library.integration.match_equality -`_). +`_). diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index 92e567d12824fa..ce247fd9da1a30 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -56,7 +56,7 @@ test runner Kent Beck's original paper on testing frameworks using the pattern shared by :mod:`unittest`. - `Nose `_ and `py.test `_ + `Nose `_ and `py.test `_ Third-party unittest frameworks with a lighter-weight syntax for writing tests. For example, ``assert func(10) == 42``. diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index 5a10f9571e9e87..292d51ff3b93d8 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -18,7 +18,7 @@ authentication, redirections, cookies and more. .. seealso:: - The `Requests package `_ + The `Requests package `_ is recommended for a higher-level HTTP client interface. diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index a1d446902b836c..50940b890fd78c 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -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 https://wsgi.readthedocs.io/en/latest/ for more information about WSGI, +and links to tutorials and other resources. .. XXX If you're just trying to write a web application... diff --git a/Doc/tutorial/interactive.rst b/Doc/tutorial/interactive.rst index d73cfeb34f1946..c0eb1feec4eb4d 100644 --- a/Doc/tutorial/interactive.rst +++ b/Doc/tutorial/interactive.rst @@ -51,4 +51,4 @@ bpython_. .. _GNU Readline: https://tiswww.case.edu/php/chet/readline/rltop.html .. _IPython: https://ipython.org/ -.. _bpython: http://www.bpython-interpreter.org/ +.. _bpython: https://www.bpython-interpreter.org/ diff --git a/Doc/tutorial/whatnow.rst b/Doc/tutorial/whatnow.rst index 1ea22ae5cdccae..cc20b3dc1d3ac4 100644 --- a/Doc/tutorial/whatnow.rst +++ b/Doc/tutorial/whatnow.rst @@ -48,7 +48,7 @@ More Python resources: Particularly notable contributions are collected in a book also titled Python Cookbook (O'Reilly & Associates, ISBN 0-596-00797-3.) -* http://www.pyvideo.org collects links to Python-related videos from +* http://pyvideo.org/ collects links to Python-related videos from conferences and user-group meetings. * https://scipy.org: The Scientific Python project includes modules for fast diff --git a/Doc/using/mac.rst b/Doc/using/mac.rst index 8f1ac3f3fd3a97..a0ef52adb1b8cd 100644 --- a/Doc/using/mac.rst +++ b/Doc/using/mac.rst @@ -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` (http://aquamacs.org/). To run your script from the Terminal window you must make sure that @@ -131,7 +131,7 @@ There are several methods to install additional Python packages: setup.py install``). * Many packages can also be installed via the :program:`setuptools` extension - or :program:`pip` wrapper, see https://pip.pypa.io/. + or :program:`pip` wrapper, see https://pip.pypa.io/en/stable/. GUI Programming on the Mac @@ -149,7 +149,7 @@ X by Apple, and the latest version can be downloaded and installed from https://www.activestate.com; it can also be built from source. *wxPython* is another popular cross-platform GUI toolkit that runs natively on -Mac OS X. Packages and documentation are available from http://www.wxpython.org. +Mac OS X. Packages and documentation are available from https://www.wxpython.org. *PyQt* is another popular cross-platform GUI toolkit that runs natively on Mac OS X. More information can be found at diff --git a/Doc/using/windows.rst b/Doc/using/windows.rst index 68687e9f3ec367..1ca0fd4a31bbdf 100644 --- a/Doc/using/windows.rst +++ b/Doc/using/windows.rst @@ -291,9 +291,9 @@ for detailed information about platforms with pre-compiled installers. by Mark Pilgrim, 2004, ISBN 1-59059-356-1 - `For Windows users `_ + `For Windows users `_ in "Installing Python" - in "`A Byte of Python `_" + in "`A Byte of Python `_" by Swaroop C H, 2003 @@ -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 Environment variables in Windows NT https://technet.microsoft.com/en-us/library/cc754250.aspx @@ -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 How To Manage Environment Variables in Windows XP https://www.chem.gla.ac.uk/~louis/software/faq/q1.html @@ -871,11 +871,11 @@ shipped with PyWin32. It is an embeddable IDE with a built-in debugger. cx_Freeze --------- -`cx_Freeze `_ is a :mod:`distutils` -extension (see :ref:`extending-distutils`) which wraps Python scripts into -executable Windows programs (:file:`{*}.exe` files). When you have done this, -you can distribute your application without requiring your users to install -Python. +`cx_Freeze `_ is a +:mod:`distutils` extension (see :ref:`extending-distutils`) which wraps +Python scripts into executable Windows programs (:file:`{*}.exe` files). +When you have done this, you can distribute your application without +requiring your users to install Python. WConio From 06fa4f3df86a12c0048210f6d94b608580351c23 Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Sun, 4 Jun 2017 00:07:01 +0530 Subject: [PATCH 03/19] Minor fixes to links --- Doc/faq/general.rst | 2 +- Doc/library/plistlib.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index 6483d8a100545d..c34d8d86eae645 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -344,7 +344,7 @@ different companies and organizations. High-profile Python projects include `the Mailman mailing list manager `_ and `the Zope application server `_. Several Linux distributions, most -notably `Red Hat`_, have written part or all of +notably `Red Hat `_, have written part or all of their installer and system administration software in Python. Companies that use Python internally include Google, Yahoo, and Lucasfilm Ltd. diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index a75f961b959995..b44619ca7ea5e7 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -38,7 +38,7 @@ or :class:`datetime.datetime` objects. .. seealso:: - `PList manual page < https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man5/plist.5.html>`_ + `PList manual page `_ Apple's documentation of the file format. From 1d99ca4e5dc0528b8fce73ba186ac198125ae8f6 Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Sun, 4 Jun 2017 14:01:04 +0530 Subject: [PATCH 04/19] bpo-25910: Address review comments --- Doc/about.rst | 2 +- Doc/faq/extending.rst | 2 +- Doc/faq/general.rst | 2 +- Doc/faq/gui.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Doc/about.rst b/Doc/about.rst index 57acdfb6f42278..e847f6fd23b02b 100644 --- a/Doc/about.rst +++ b/Doc/about.rst @@ -7,7 +7,7 @@ These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a document processor specifically written for the Python documentation. .. _reStructuredText: http://docutils.sourceforge.net/rst.html -.. _Sphinx: http://www.sphinx-doc.org/en/stable/ +.. _Sphinx: http://www.sphinx-doc.org .. In the online version of these documents, you can submit comments and suggest changes directly on the documentation pages. diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst index d1e687f69d35ef..b3f90aef7f4a3a 100644 --- a/Doc/faq/extending.rst +++ b/Doc/faq/extending.rst @@ -52,7 +52,7 @@ currently exists, you can try wrapping the library's data types and functions with a tool such as `SWIG `_. `SIP `__, `CXX `_ `Boost -`_, or +`_, or `Weave `_ are also alternatives for wrapping C++ libraries. diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index c34d8d86eae645..f52bbce2ec5c89 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -53,7 +53,7 @@ commercial use, to sell copies of Python in source or binary form (modified or unmodified), or to sell products that incorporate Python in some form. We would still like to know about all commercial use of Python, of course. -See `the PSF license page `_ to find further +See `the PSF license page `_ to find further explanations and a link to the full text of the license. The Python logo is trademarked, and in certain cases permission is required to diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index 927229ce119e83..2e372ce327ca4b 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -90,7 +90,7 @@ Kivy is free and open source software distributed under the MIT license. FLTK ---- -Python bindings for `the FLTK toolkit `_, a simple yet +Python bindings for `the FLTK toolkit `_, a simple yet powerful and mature cross-platform windowing system, are available from `the PyFLTK project `_. From 0f9643574aa3619998fad95731702eaebf3c9c4b Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Mon, 5 Jun 2017 14:59:41 +0530 Subject: [PATCH 05/19] bpo-25910: Address review comments --- Doc/distributing/index.rst | 2 +- Doc/extending/extending.rst | 2 +- Doc/faq/design.rst | 2 +- Doc/faq/extending.rst | 2 +- Doc/faq/general.rst | 9 +++++---- Doc/faq/gui.rst | 2 +- Doc/faq/programming.rst | 3 +-- Doc/faq/windows.rst | 2 +- Doc/howto/pyporting.rst | 2 +- Doc/library/ast.rst | 6 +++--- Doc/library/gettext.rst | 8 ++++---- Doc/library/http.client.rst | 4 ++-- Doc/library/othergui.rst | 2 +- Doc/library/trace.rst | 2 +- Doc/library/unittest.rst | 2 +- Doc/library/urllib.request.rst | 4 ++-- Doc/library/wsgiref.rst | 4 ++-- 17 files changed, 29 insertions(+), 29 deletions(-) diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 3004d330b9efa7..656d9740dd6892 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -62,7 +62,7 @@ Key terms locally. .. _setuptools: https://setuptools.readthedocs.io/en/latest/ -.. _wheel: https://wheel.readthedocs.io/en/latest/ +.. _wheel: https://wheel.readthedocs.io/ Open source licensing and collaboration ======================================= diff --git a/Doc/extending/extending.rst b/Doc/extending/extending.rst index 356f421e571601..3723b2b3fe476f 100644 --- a/Doc/extending/extending.rst +++ b/Doc/extending/extending.rst @@ -27,7 +27,7 @@ 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 - `_ library rather than writing + `_ library rather than writing 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 diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index a1861901bc155b..20905d17d35c90 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -370,7 +370,7 @@ Can Python be compiled to machine code, C or some other language? optional annotations into C extensions. `Nuitka `_ is an up-and-coming compiler of Python into C++ code, aiming to support the full Python language. For compiling to Java you can consider -`VOC `_. +`VOC `_. How does Python manage memory? diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst index b3f90aef7f4a3a..27edb77853b704 100644 --- a/Doc/faq/extending.rst +++ b/Doc/faq/extending.rst @@ -440,6 +440,6 @@ Can I create an object class with some methods implemented in C and others in Py Yes, you can inherit from built-in classes such as :class:`int`, :class:`list`, :class:`dict`, etc. -The Boost Python Library (BPL, http://www.boost.org/doc/libs/1_64_0/libs/python/doc/html/index.html) +The Boost Python Library (BPL, http://www.boost.org/libs/python/doc/index.html) provides a way of doing this from C++ (i.e. you can inherit from an extension class written in C++ using the BPL). diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index f52bbce2ec5c89..4125792d323bcf 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -343,10 +343,10 @@ different companies and organizations. High-profile Python projects include `the Mailman mailing list manager `_ and `the Zope application server -`_. Several Linux distributions, most -notably `Red Hat `_, have written part or all of -their installer and system administration software in Python. Companies -that use Python internally include Google, Yahoo, and Lucasfilm Ltd. +`_. Several Linux distributions, most notably `Red +Hat `_, have written part or all of their installer +and system administration software in Python. Companies that use Python +internally include Google, Yahoo, and Lucasfilm Ltd. What new developments are expected for Python in the future? @@ -358,6 +358,7 @@ providing a concise technical specification and a rationale. Look for a PEP titled "Python X.Y Release Schedule", where X.Y is a version that hasn't been publicly released yet. + New development is discussed on `the python-dev mailing list `_. diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index 2e372ce327ca4b..79b8686102769c 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -72,7 +72,7 @@ Gtk+ The `GObject introspection bindings `_ for Python allow you to write GTK+ 3 applications. There is also a -`Python GTK+ 3 Tutorial `_. +`Python GTK+ 3 Tutorial `_. The older PyGtk bindings for the `Gtk+ 2 toolkit `_ have been implemented by James Henstridge; see . diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index f2fa0b786cf620..291f57b615226c 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -69,8 +69,7 @@ plug-ins to add a custom feature. In addition to the bug checking that PyChecker performs, Pylint offers some additional features such as checking line length, whether variable names are well-formed according to your coding standard, whether declared interfaces are fully implemented, and more. -https://pylint.readthedocs.io/en/latest/ provides a full list of Pylint's -features. +https://pylint.readthedocs.io/ provides a full list of Pylint's features. How can I create a stand-alone binary from a Python script? diff --git a/Doc/faq/windows.rst b/Doc/faq/windows.rst index fcb211f4a47a98..8349cf2bf0985f 100644 --- a/Doc/faq/windows.rst +++ b/Doc/faq/windows.rst @@ -341,5 +341,5 @@ This is a mistake; the extension should be .TGZ. Simply rename the downloaded file to have the .TGZ extension, and WinZip will be able to handle it. (If your copy of WinZip doesn't, get a newer one from -http://www.winzip.com/win/en/.) +http://www.winzip.com/.) diff --git a/Doc/howto/pyporting.rst b/Doc/howto/pyporting.rst index 3911aa115152f8..40f47f075fc90d 100644 --- a/Doc/howto/pyporting.rst +++ b/Doc/howto/pyporting.rst @@ -433,7 +433,7 @@ 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.io/en/latest/ +.. _Modernize: https://python-modernize.readthedocs.io/ .. _mypy: http://mypy-lang.org/ .. _Porting to Python 3: http://python3porting.com/ .. _Pylint: https://pypi.python.org/pypi/pylint diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst index 5236b84f394e17..cb4c3efef10208 100644 --- a/Doc/library/ast.rst +++ b/Doc/library/ast.rst @@ -261,6 +261,6 @@ and classes for traversing abstract syntax trees: .. seealso:: - `Green Tree Snakes `_, - an external documentation resource, has good details on working with - Python ASTs. + `Green Tree Snakes `_, an + external documentation resource, has good details on working with Python + ASTs. diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst index a986f474236e99..c1665256b5b4e2 100644 --- a/Doc/library/gettext.rst +++ b/Doc/library/gettext.rst @@ -457,11 +457,11 @@ There are a few tools to extract the strings meant for translation. The original GNU :program:`gettext` only supported C or C++ source code but its extended version :program:`xgettext` scans code written in a number of languages, including Python, to find strings marked as -translatable. `Babel `__ is a Python +translatable. `Babel `__ is a Python internationalization library that includes a :file:`pybabel` script to -extract and compile message catalogs. François Pinard's program -called :program:`xpot` does a similar job and is available as part of -his `po-utils package `__. +extract and compile message catalogs. François Pinard's program called +:program:`xpot` does a similar job and is available as part of his `po-utils + package `__. (Python also includes pure-Python versions of these programs, called :program:`pygettext.py` and :program:`msgfmt.py`; some Python distributions diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index 6c40203607396e..cd67e140ec7e0a 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -20,8 +20,8 @@ HTTPS protocols. It is normally not used directly --- the module .. seealso:: - The `Requests package `_ - is recommended for a higher-level HTTP client interface. + The `Requests package `_ is + recommended for a higher-level HTTP client interface. .. note:: diff --git a/Doc/library/othergui.rst b/Doc/library/othergui.rst index fcc7c4251a0d34..4be6c1a6866f1b 100644 --- a/Doc/library/othergui.rst +++ b/Doc/library/othergui.rst @@ -13,7 +13,7 @@ available for Python: `GObject `_. One of these libraries is the `GTK+ 3 `_ widget set. GTK+ comes with many more widgets than Tkinter provides. An online - `Python GTK+ 3 Tutorial `_ + `Python GTK+ 3 Tutorial `_ is available. `PyGTK `_ diff --git a/Doc/library/trace.rst b/Doc/library/trace.rst index 2eed748c6347a2..5cb7029adf5e9e 100644 --- a/Doc/library/trace.rst +++ b/Doc/library/trace.rst @@ -15,7 +15,7 @@ or from the command line. .. seealso:: - `Coverage.py `_ + `Coverage.py `_ A popular third-party coverage tool that provides HTML output along with advanced features such as branch coverage. diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index ce247fd9da1a30..26d71182628b8b 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -56,7 +56,7 @@ test runner Kent Beck's original paper on testing frameworks using the pattern shared by :mod:`unittest`. - `Nose `_ and `py.test `_ + `Nose `_ and `py.test `_ Third-party unittest frameworks with a lighter-weight syntax for writing tests. For example, ``assert func(10) == 42``. diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index 292d51ff3b93d8..c5e3ca7cdbfb77 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -18,8 +18,8 @@ authentication, redirections, cookies and more. .. seealso:: - The `Requests package `_ - is recommended for a higher-level HTTP client interface. + The `Requests package `_ is + recommended for a higher-level HTTP client interface. The :mod:`urllib.request` module defines the following functions: diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index 50940b890fd78c..dc4671a2b8ecd7 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -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.io/en/latest/ for more information about WSGI, -and links to tutorials and other resources. +See https://wsgi.readthedocs.io/ for more information about WSGI, and links +to tutorials and other resources. .. XXX If you're just trying to write a web application... From cc1b307c2eef8925f027aeda580bb8b1f398fd54 Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Mon, 5 Jun 2017 15:12:37 +0530 Subject: [PATCH 06/19] bpo-25910: Minor fix to gettext.rst doc --- Doc/library/gettext.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst index c1665256b5b4e2..b691c27e6bd05e 100644 --- a/Doc/library/gettext.rst +++ b/Doc/library/gettext.rst @@ -460,8 +460,8 @@ in a number of languages, including Python, to find strings marked as translatable. `Babel `__ is a Python internationalization library that includes a :file:`pybabel` script to extract and compile message catalogs. François Pinard's program called -:program:`xpot` does a similar job and is available as part of his `po-utils - package `__. +:program:`xpot` does a similar job and is available as part of his +`po-utils package `__. (Python also includes pure-Python versions of these programs, called :program:`pygettext.py` and :program:`msgfmt.py`; some Python distributions From bf9d3f812590ec3a8795e04b2e430ac889479e6c Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Mon, 5 Jun 2017 15:31:55 +0530 Subject: [PATCH 07/19] bpo-25910: Minor link fix in installing/index.rst doc --- Doc/installing/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/installing/index.rst b/Doc/installing/index.rst index b22465df2910eb..0a1eea9a1a6db2 100644 --- a/Doc/installing/index.rst +++ b/Doc/installing/index.rst @@ -48,11 +48,11 @@ Key terms repository of open source licensed packages made available for use by other Python users. * the `Python Packaging Authority - `__ are the group of - 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, - and issue trackers on both `GitHub `__ and + `__ are the group of 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, and issue trackers on + both `GitHub `__ and `BitBucket `__. * ``distutils`` is the original build and distribution system first added to the Python standard library in 1998. While direct use of ``distutils`` is From 92f023ffa47bc49cb14fb57ecd5bcd470b931505 Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Mon, 5 Jun 2017 16:20:12 +0530 Subject: [PATCH 08/19] bpo-25910: Fixes redirection issues in whatsnew/* doc --- Doc/whatsnew/2.3.rst | 12 ++++++------ Doc/whatsnew/2.6.rst | 2 +- Doc/whatsnew/2.7.rst | 6 +++--- Doc/whatsnew/3.6.rst | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index cebfb21156bf69..20f96278c269b6 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -218,11 +218,11 @@ 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 -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 -like:: +(https://www2.cs.arizona.edu/icon/), where the idea of generators is central +. In Icon, every expression and function call behaves like a generator. +One example from "An Overview of the Icon Programming Language" at +https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this +looks like:: sentence := "Store it in the neighboring harbor" if (i := find("or", sentence)) > 5 then write(i) @@ -1955,7 +1955,7 @@ The RPM spec files, found in the :file:`Misc/RPM/` directory in the Python source distribution, were updated for 2.3. (Contributed by Sean Reifschneider.) Other new platforms now supported by Python include AtheOS -(http://atheos.cx/), GNU/Hurd, and OpenVMS. +(http://www.atheos.cx/), GNU/Hurd, and OpenVMS. .. ====================================================================== diff --git a/Doc/whatsnew/2.6.rst b/Doc/whatsnew/2.6.rst index cc2fa3dcfa50ce..db4d201163c430 100644 --- a/Doc/whatsnew/2.6.rst +++ b/Doc/whatsnew/2.6.rst @@ -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 `__ +`Upfront Systems `__ 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 diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst index 55392fc2be0872..765d424a9b59cf 100644 --- a/Doc/whatsnew/2.7.rst +++ b/Doc/whatsnew/2.7.rst @@ -1809,7 +1809,7 @@ wish to read the Tcl/Tk manual page describing the Ttk theme engine, available at https://www.tcl.tk/man/tcl8.5/TkCmd/ttk_intro.htm. Some screenshots of the Python/Ttk code in use are at -http://code.google.com/p/python-ttk/wiki/Screenshots. +https://code.google.com/archive/p/python-ttk/wikis/Screenshots.wiki. The :mod:`ttk` module was written by Guilherme Polo and added in :issue:`2983`. An alternate version called ``Tile.py``, written by @@ -1832,8 +1832,8 @@ https://pypi.python.org/pypi/unittest2. When used from the command line, the module can automatically discover tests. It's not as fancy as `py.test `__ or -`nose `__, but provides a simple way -to run tests kept within a set of package directories. For example, +`nose `__, but provides a +simple way to run tests kept within a set of package directories. For example, the following command will search the :file:`test/` subdirectory for any importable test files named ``test*.py``:: diff --git a/Doc/whatsnew/3.6.rst b/Doc/whatsnew/3.6.rst index 60469cd1d36519..48a0c23cdd7581 100644 --- a/Doc/whatsnew/3.6.rst +++ b/Doc/whatsnew/3.6.rst @@ -238,8 +238,8 @@ and the ``__annotations__`` attribute. and Guido van Rossum. Implemented by Ivan Levkivskyi. Tools that use or will use the new syntax: - `mypy `_, - `pytype `_, PyCharm, etc. + `mypy `_, + `pytype `_, PyCharm, etc. .. _whatsnew36-pep515: @@ -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 -`_.) +`_.) A new :const:`~typing.TYPE_CHECKING` constant that is assumed to be ``True`` by the static type chekers, but is ``False`` at runtime. From 32b6617116aa3e72be2368c69ab7f98bfc37f5a0 Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Mon, 5 Jun 2017 22:35:07 +0530 Subject: [PATCH 09/19] bpo-25910: Address review commits for url redirections --- Doc/about.rst | 2 +- Doc/distributing/index.rst | 10 +++++----- Doc/faq/design.rst | 2 +- Doc/faq/extending.rst | 4 ++-- Doc/faq/general.rst | 9 ++++----- Doc/faq/gui.rst | 14 +++++++------- Doc/faq/library.rst | 2 +- Doc/faq/programming.rst | 2 +- Doc/faq/windows.rst | 2 +- Doc/howto/curses.rst | 2 +- Doc/howto/pyporting.rst | 2 +- Doc/library/distutils.rst | 2 +- Doc/library/http.client.rst | 4 ++-- Doc/library/othergui.rst | 2 +- Doc/library/smtpd.rst | 2 +- Doc/tutorial/whatnow.rst | 2 +- Doc/using/mac.rst | 2 +- Doc/whatsnew/2.3.rst | 2 +- 18 files changed, 33 insertions(+), 34 deletions(-) diff --git a/Doc/about.rst b/Doc/about.rst index e847f6fd23b02b..3ea311fa629dd2 100644 --- a/Doc/about.rst +++ b/Doc/about.rst @@ -7,7 +7,7 @@ These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a document processor specifically written for the Python documentation. .. _reStructuredText: http://docutils.sourceforge.net/rst.html -.. _Sphinx: http://www.sphinx-doc.org +.. _Sphinx: http://sphinx-doc.org/ .. In the online version of these documents, you can submit comments and suggest changes directly on the documentation pages. diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 656d9740dd6892..5563a5ed979609 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -35,11 +35,11 @@ Key terms repository of open source licensed packages made available for use by other Python users * the `Python Packaging Authority - `__ are the group of - 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 - and issue trackers on both `GitHub `__ and + `__ are the group of 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 and issue trackers on both + `GitHub `__ and `BitBucket `__. * :mod:`distutils` is the original build and distribution system first added to the Python standard library in 1998. While direct use of :mod:`distutils` diff --git a/Doc/faq/design.rst b/Doc/faq/design.rst index 20905d17d35c90..2e56fbc2f425ec 100644 --- a/Doc/faq/design.rst +++ b/Doc/faq/design.rst @@ -370,7 +370,7 @@ Can Python be compiled to machine code, C or some other language? optional annotations into C extensions. `Nuitka `_ is an up-and-coming compiler of Python into C++ code, aiming to support the full Python language. For compiling to Java you can consider -`VOC `_. +`VOC `_. How does Python manage memory? diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst index 27edb77853b704..3eafdf193c80a4 100644 --- a/Doc/faq/extending.rst +++ b/Doc/faq/extending.rst @@ -52,8 +52,8 @@ currently exists, you can try wrapping the library's data types and functions with a tool such as `SWIG `_. `SIP `__, `CXX `_ `Boost -`_, or -`Weave `_ are also +`_, or `Weave +`_ are also alternatives for wrapping C++ libraries. diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index 4125792d323bcf..b046245b98fe18 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -181,8 +181,8 @@ at https://docs.python.org/3/. PDF, plain text, and downloadable HTML versions also available at https://docs.python.org/3/download.html. The documentation is written in reStructuredText and processed by `the Sphinx -documentation tool `__. The reStructuredText source for -the documentation is part of the Python source distribution. +documentation tool `__. The reStructuredText source +for the documentation is part of the Python source distribution. I've never programmed before. Is there a Python tutorial? @@ -343,8 +343,8 @@ different companies and organizations. High-profile Python projects include `the Mailman mailing list manager `_ and `the Zope application server -`_. Several Linux distributions, most notably `Red -Hat `_, have written part or all of their installer +`_. Several Linux distributions, most notably `Red Hat +`_, have written part or all of their installer and system administration software in Python. Companies that use Python internally include Google, Yahoo, and Lucasfilm Ltd. @@ -358,7 +358,6 @@ providing a concise technical specification and a rationale. Look for a PEP titled "Python X.Y Release Schedule", where X.Y is a version that hasn't been publicly released yet. - New development is discussed on `the python-dev mailing list `_. diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index 79b8686102769c..4a4de60d4ada8c 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -43,11 +43,11 @@ number of platforms, with Windows, Mac OS X, GTK, X11, all listed as current stable targets. Language bindings are available for a number of languages including Python, Perl, Ruby, etc. -wxPython (https://www.wxpython.org/) is the Python binding for -wxwidgets. While it often lags slightly behind the official wxWidgets -releases, it also offers a number of features via pure Python -extensions that are not available in other language bindings. There -is an active wxPython user and developer community. +wxPython (https://www.wxpython.org) is the Python binding for wxwidgets. +While it often lags slightly behind the official wxWidgets releases, it also +offers a number of features via pure Python extensions that are not +available in other language bindings. There is an active wxPython user and +developer community. Both wxWidgets and wxPython are free, open source, software with permissive licences that allow their use in commercial products as @@ -74,7 +74,7 @@ The `GObject introspection bindings ` for Python allow you to write GTK+ 3 applications. There is also a `Python GTK+ 3 Tutorial `_. -The older PyGtk bindings for the `Gtk+ 2 toolkit `_ have +The older PyGtk bindings for the `Gtk+ 2 toolkit `_ have been implemented by James Henstridge; see . Kivy @@ -90,7 +90,7 @@ Kivy is free and open source software distributed under the MIT license. FLTK ---- -Python bindings for `the FLTK toolkit `_, a simple yet +Python bindings for `the FLTK toolkit `_, a simple yet powerful and mature cross-platform windowing system, are available from `the PyFLTK project `_. diff --git a/Doc/faq/library.rst b/Doc/faq/library.rst index 00d3e325692005..f84feadd780234 100644 --- a/Doc/faq/library.rst +++ b/Doc/faq/library.rst @@ -182,7 +182,7 @@ How do I create documentation from doc strings? The :mod:`pydoc` module can create HTML from the doc strings in your Python source code. An alternative for creating API documentation purely from docstrings is `epydoc `_. `Sphinx -`_ can also include docstring content. +`_ can also include docstring content. How do I get a single keypress at a time? diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index 291f57b615226c..e53d1516eba74f 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -69,7 +69,7 @@ plug-ins to add a custom feature. In addition to the bug checking that PyChecker performs, Pylint offers some additional features such as checking line length, whether variable names are well-formed according to your coding standard, whether declared interfaces are fully implemented, and more. -https://pylint.readthedocs.io/ provides a full list of Pylint's features. +https://docs.pylint.org/ provides a full list of Pylint's features. How can I create a stand-alone binary from a Python script? diff --git a/Doc/faq/windows.rst b/Doc/faq/windows.rst index 8349cf2bf0985f..af7ffc55025e16 100644 --- a/Doc/faq/windows.rst +++ b/Doc/faq/windows.rst @@ -341,5 +341,5 @@ This is a mistake; the extension should be .TGZ. Simply rename the downloaded file to have the .TGZ extension, and WinZip will be able to handle it. (If your copy of WinZip doesn't, get a newer one from -http://www.winzip.com/.) +https://www.winzip.com.) diff --git a/Doc/howto/curses.rst b/Doc/howto/curses.rst index 9b4e9e299aea38..c1feee5e30080d 100644 --- a/Doc/howto/curses.rst +++ b/Doc/howto/curses.rst @@ -547,6 +547,6 @@ learn more about submitting patches to Python. * `The ncurses FAQ `_ * `"Use curses... don't swear" `_: video of a PyCon 2013 talk on controlling terminals using curses or Urwid. -* `"Console Applications with Urwid" `_: +* `"Console Applications with Urwid" `_: video of a PyCon CA 2012 talk demonstrating some applications written using Urwid. diff --git a/Doc/howto/pyporting.rst b/Doc/howto/pyporting.rst index 40f47f075fc90d..98c81206741a49 100644 --- a/Doc/howto/pyporting.rst +++ b/Doc/howto/pyporting.rst @@ -449,4 +449,4 @@ to make sure everything functions as expected in both versions of Python. .. _"What's New": https://docs.python.org/3/whatsnew/index.html -.. _Why Python 3 exists: https://snarky.ca/why-python-3-exists/ +.. _Why Python 3 exists: https://snarky.ca/why-python-3-exists diff --git a/Doc/library/distutils.rst b/Doc/library/distutils.rst index 44751fc5b1e856..62abc85ac397a4 100644 --- a/Doc/library/distutils.rst +++ b/Doc/library/distutils.rst @@ -29,7 +29,7 @@ enhanced alternative to :mod:`distutils` that provides: installation time rather than needing to prebuild them * consistent behaviour across all supported Python versions -The recommended `pip `__ installer runs all +The recommended `pip `__ installer runs all ``setup.py`` scripts with ``setuptools``, even if the script itself only imports ``distutils``. Refer to the `Python Packaging User Guide `_ for more diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst index cd67e140ec7e0a..53de40f63ca471 100644 --- a/Doc/library/http.client.rst +++ b/Doc/library/http.client.rst @@ -20,8 +20,8 @@ HTTPS protocols. It is normally not used directly --- the module .. seealso:: - The `Requests package `_ is - recommended for a higher-level HTTP client interface. + The `Requests package `_ + is recommended for a higher-level HTTP client interface. .. note:: diff --git a/Doc/library/othergui.rst b/Doc/library/othergui.rst index 4be6c1a6866f1b..4548459f8e261d 100644 --- a/Doc/library/othergui.rst +++ b/Doc/library/othergui.rst @@ -35,7 +35,7 @@ available for Python: Compared to PyQt, its licensing scheme is friendlier to non-open source applications. - `wxPython `_ + `wxPython `_ wxPython is a cross-platform GUI toolkit for Python that is built around the popular `wxWidgets `_ (formerly wxWindows) C++ toolkit. It provides a native look and feel for applications on diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst index beefb34fd8116d..4ba769cee1185d 100644 --- a/Doc/library/smtpd.rst +++ b/Doc/library/smtpd.rst @@ -15,7 +15,7 @@ This module offers several classes to implement SMTP (email) servers. .. seealso:: - The `aiosmtpd `_ package is a + The `aiosmtpd `_ package is a recommended replacement for this module. It is based on :mod:`asyncio` and provides a more straightforward API. :mod:`smtpd` should be considered deprecated. diff --git a/Doc/tutorial/whatnow.rst b/Doc/tutorial/whatnow.rst index cc20b3dc1d3ac4..1ea22ae5cdccae 100644 --- a/Doc/tutorial/whatnow.rst +++ b/Doc/tutorial/whatnow.rst @@ -48,7 +48,7 @@ More Python resources: Particularly notable contributions are collected in a book also titled Python Cookbook (O'Reilly & Associates, ISBN 0-596-00797-3.) -* http://pyvideo.org/ collects links to Python-related videos from +* http://www.pyvideo.org collects links to Python-related videos from conferences and user-group meetings. * https://scipy.org: The Scientific Python project includes modules for fast diff --git a/Doc/using/mac.rst b/Doc/using/mac.rst index a0ef52adb1b8cd..f37c34f5ddd073 100644 --- a/Doc/using/mac.rst +++ b/Doc/using/mac.rst @@ -131,7 +131,7 @@ There are several methods to install additional Python packages: setup.py install``). * Many packages can also be installed via the :program:`setuptools` extension - or :program:`pip` wrapper, see https://pip.pypa.io/en/stable/. + or :program:`pip` wrapper, see https://pip.pypa.io/. GUI Programming on the Mac diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index 20f96278c269b6..f11f6fa4d0df96 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -1955,7 +1955,7 @@ The RPM spec files, found in the :file:`Misc/RPM/` directory in the Python source distribution, were updated for 2.3. (Contributed by Sean Reifschneider.) Other new platforms now supported by Python include AtheOS -(http://www.atheos.cx/), GNU/Hurd, and OpenVMS. +(http://atheos.cx/), GNU/Hurd, and OpenVMS. .. ====================================================================== From 91060c308839ac717f3cf201e679f7390b848df2 Mon Sep 17 00:00:00 2001 From: CuriousLearner Date: Mon, 5 Jun 2017 22:38:55 +0530 Subject: [PATCH 10/19] bpo-25910: Minor fix for building docs succesfully --- Doc/distributing/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 5563a5ed979609..b7082a95855716 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -39,7 +39,7 @@ Key terms 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 and issue trackers on both - `GitHub `__ and + `GitHub `__ and `BitBucket `__. * :mod:`distutils` is the original build and distribution system first added to the Python standard library in 1998. While direct use of :mod:`distutils` From 23cc93c3c681e0ab47d81a91084c34ad897d7dc2 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Sat, 2 Dec 2017 17:11:25 +0530 Subject: [PATCH 11/19] bpo-25910: Reverts change to not lose git blame on docs --- Doc/distributing/index.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index b7082a95855716..40ed079ee7f6e3 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -35,11 +35,11 @@ Key terms repository of open source licensed packages made available for use by other Python users * the `Python Packaging Authority - `__ are the group of 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 and issue trackers on both - `GitHub `__ and + `__ are the group of + 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 + and issue trackers on both `GitHub `__ and `BitBucket `__. * :mod:`distutils` is the original build and distribution system first added to the Python standard library in 1998. While direct use of :mod:`distutils` From 4b3f4885ae62904d1f15e351d2c91df3e4ed5761 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Thu, 7 Dec 2017 00:36:55 +0530 Subject: [PATCH 12/19] Revert changes that might change git blame --- Doc/faq/general.rst | 10 +++++----- Doc/installing/index.rst | 11 +++++------ Doc/library/ast.rst | 5 ++--- Doc/library/gettext.rst | 6 +++--- Doc/library/smtpd.rst | 7 +++---- Doc/library/urllib.request.rst | 4 ++-- Doc/whatsnew/2.3.rst | 10 +++++----- 7 files changed, 25 insertions(+), 28 deletions(-) diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index facf49673de607..46ae5d16c253d4 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -181,8 +181,8 @@ at https://docs.python.org/3/. PDF, plain text, and downloadable HTML versions also available at https://docs.python.org/3/download.html. The documentation is written in reStructuredText and processed by `the Sphinx -documentation tool `__. The reStructuredText source -for the documentation is part of the Python source distribution. +documentation tool `__. The reStructuredText source for +the documentation is part of the Python source distribution. I've never programmed before. Is there a Python tutorial? @@ -344,9 +344,9 @@ different companies and organizations. High-profile Python projects include `the Mailman mailing list manager `_ and `the Zope application server `_. Several Linux distributions, most notably `Red Hat -`_, have written part or all of their installer -and system administration software in Python. Companies that use Python -internally include Google, Yahoo, and Lucasfilm Ltd. +`_, have written part or all of their installer and +system administration software in Python. Companies that use Python internally +include Google, Yahoo, and Lucasfilm Ltd. What new developments are expected for Python in the future? diff --git a/Doc/installing/index.rst b/Doc/installing/index.rst index 94373795439d6a..37069ec8312078 100644 --- a/Doc/installing/index.rst +++ b/Doc/installing/index.rst @@ -48,12 +48,11 @@ Key terms repository of open source licensed packages made available for use by other Python users. * the `Python Packaging Authority - `__ are the group of 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, and issue trackers on - both `GitHub `__ and - `BitBucket `__. + `__ are the group of + 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, + and issue trackers on both `GitHub `__ and * ``distutils`` is the original build and distribution system first added to the Python standard library in 1998. While direct use of ``distutils`` is being phased out, it still laid the foundation for the current packaging diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst index cb4c3efef10208..bda46f46c43667 100644 --- a/Doc/library/ast.rst +++ b/Doc/library/ast.rst @@ -261,6 +261,5 @@ and classes for traversing abstract syntax trees: .. seealso:: - `Green Tree Snakes `_, an - external documentation resource, has good details on working with Python - ASTs. + `Green Tree Snakes `_, an external documentation resource, has good + details on working with Python ASTs. diff --git a/Doc/library/gettext.rst b/Doc/library/gettext.rst index 59e3d55dda1ff7..407853c2d7efad 100644 --- a/Doc/library/gettext.rst +++ b/Doc/library/gettext.rst @@ -458,9 +458,9 @@ code but its extended version :program:`xgettext` scans code written in a number of languages, including Python, to find strings marked as translatable. `Babel `__ is a Python internationalization library that includes a :file:`pybabel` script to -extract and compile message catalogs. François Pinard's program called -:program:`xpot` does a similar job and is available as part of his -`po-utils package `__. +extract and compile message catalogs. François Pinard's program +called :program:`xpot` does a similar job and is available as part of +his `po-utils package `__. (Python also includes pure-Python versions of these programs, called :program:`pygettext.py` and :program:`msgfmt.py`; some Python distributions diff --git a/Doc/library/smtpd.rst b/Doc/library/smtpd.rst index 4ba769cee1185d..85ee8a75cf77a9 100644 --- a/Doc/library/smtpd.rst +++ b/Doc/library/smtpd.rst @@ -15,10 +15,9 @@ This module offers several classes to implement SMTP (email) servers. .. seealso:: - The `aiosmtpd `_ package is a - recommended replacement for this module. It is based on :mod:`asyncio` - and provides a more straightforward API. :mod:`smtpd` should be - considered deprecated. + The `aiosmtpd `_ package is a recommended + replacement for this module. It is based on :mod:`asyncio` and provides a + more straightforward API. :mod:`smtpd` should be considered deprecated. Several server implementations are present; one is a generic do-nothing implementation, which can be overridden, while the other two offer diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index c5e3ca7cdbfb77..5a10f9571e9e87 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -18,8 +18,8 @@ authentication, redirections, cookies and more. .. seealso:: - The `Requests package `_ is - recommended for a higher-level HTTP client interface. + The `Requests package `_ + is recommended for a higher-level HTTP client interface. The :mod:`urllib.request` module defines the following functions: diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index f11f6fa4d0df96..6bd8f467b0f0d4 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -218,11 +218,11 @@ 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://www2.cs.arizona.edu/icon/), where the idea of generators is central -. In Icon, every expression and function call behaves like a generator. -One example from "An Overview of the Icon Programming Language" at -https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this -looks like:: +(https://www2.cs.arizona.edu/icon/), where the idea of generators is central. In +Icon, every expression and function call behaves like a generator. One example +from "An Overview of the Icon Programming Language" at +https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks +like:: sentence := "Store it in the neighboring harbor" if (i := find("or", sentence)) > 5 then write(i) From 2bb0157247f1719ef1f81ebab70d016ad323063b Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Thu, 7 Dec 2017 00:38:50 +0530 Subject: [PATCH 13/19] Minor fix to bitbucket link --- Doc/installing/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/Doc/installing/index.rst b/Doc/installing/index.rst index 37069ec8312078..f9a224be92b8be 100644 --- a/Doc/installing/index.rst +++ b/Doc/installing/index.rst @@ -53,6 +53,7 @@ Key terms evolution of the standard packaging tools and the associated metadata and file format standards. They maintain a variety of tools, documentation, and issue trackers on both `GitHub `__ and + `BitBucket `__. * ``distutils`` is the original build and distribution system first added to the Python standard library in 1998. While direct use of ``distutils`` is being phased out, it still laid the foundation for the current packaging From b44cc3f791997f25e4e5de3b88b2ec57373eb79f Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Wed, 13 Dec 2017 23:20:20 +0530 Subject: [PATCH 14/19] Address review comments --- Doc/distributing/index.rst | 10 +++++----- Doc/distutils/index.rst | 2 +- Doc/extending/index.rst | 2 +- Doc/faq/general.rst | 2 +- Doc/install/index.rst | 2 +- Doc/library/ssl.rst | 4 ++-- Doc/library/wsgiref.rst | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/Doc/distributing/index.rst b/Doc/distributing/index.rst index 40ed079ee7f6e3..aedbe712d3db33 100644 --- a/Doc/distributing/index.rst +++ b/Doc/distributing/index.rst @@ -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/current/#packaging-tool-recommendations +.. _currently recommended tools: https://packaging.python.org/guides/tool-recommendations/#packaging-tool-recommendations Reading the guide ================= @@ -124,11 +124,11 @@ involved in creating a project: * `Uploading the project to the Python Packaging Index`_ .. _Project structure: \ - https://packaging.python.org/distributing/ + https://packaging.python.org/tutorials/distributing-packages/ .. _Building and packaging the project: \ - https://packaging.python.org/distributing/#packaging-your-project + https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project .. _Uploading the project to the Python Packaging Index: \ - https://packaging.python.org/distributing/#uploading-your-project-to-pypi + https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi How do I...? @@ -160,7 +160,7 @@ Python Packaging User Guide for more information and recommendations. .. seealso:: `Python Packaging User Guide: Binary Extensions - `__ + `__ .. other topics: diff --git a/Doc/distutils/index.rst b/Doc/distutils/index.rst index 847208597fd9e8..d6f7640fcb6826 100644 --- a/Doc/distutils/index.rst +++ b/Doc/distutils/index.rst @@ -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 `__ + recommendations section `__ in the Python Packaging User Guide for more information. .. toctree:: diff --git a/Doc/extending/index.rst b/Doc/extending/index.rst index 021e2977fc9f92..80594e357fd497 100644 --- a/Doc/extending/index.rst +++ b/Doc/extending/index.rst @@ -32,7 +32,7 @@ approaches to creating C and C++ extensions for Python. .. seealso:: - `Python Packaging User Guide: Binary Extensions `_ + `Python Packaging User Guide: Binary Extensions `_ 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 diff --git a/Doc/faq/general.rst b/Doc/faq/general.rst index 46ae5d16c253d4..0d1cb198da87d8 100644 --- a/Doc/faq/general.rst +++ b/Doc/faq/general.rst @@ -344,7 +344,7 @@ different companies and organizations. High-profile Python projects include `the Mailman mailing list manager `_ and `the Zope application server `_. Several Linux distributions, most notably `Red Hat -`_, have written part or all of their installer and +`_, have written part or all of their installer and system administration software in Python. Companies that use Python internally include Google, Yahoo, and Lucasfilm Ltd. diff --git a/Doc/install/index.rst b/Doc/install/index.rst index 8b593431b71953..0545b8f33d0378 100644 --- a/Doc/install/index.rst +++ b/Doc/install/index.rst @@ -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 `__ + recommendations section `__ in the Python Packaging User Guide for more information. diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 6131c512115188..b898eaf26062db 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -869,7 +869,7 @@ Constants Whether the OpenSSL library has built-in support for *Next Protocol Negotiation* as described in the `NPN draft specification - `_. When true, + `_. When true, you can use the :meth:`SSLContext.set_npn_protocols` method to advertise which protocols you want to support. @@ -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 - `_. After a + `_. After a successful handshake, the :meth:`SSLSocket.selected_npn_protocol` method will return the agreed-upon protocol. diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index dc4671a2b8ecd7..57a2d2e86708be 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -26,7 +26,7 @@ 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.io/ for more information about WSGI, and links +See wsgi.readthedocs.io _ for more information about WSGI, and links to tutorials and other resources. .. XXX If you're just trying to write a web application... From 3f6c78abcc9f4ccd4cf9f12bebc1d99c7a823690 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Sat, 16 Dec 2017 21:16:21 +0530 Subject: [PATCH 15/19] Address review comments --- Doc/library/plistlib.rst | 2 +- Doc/library/statistics.rst | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index b44619ca7ea5e7..20c086c8b524a5 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -38,7 +38,7 @@ or :class:`datetime.datetime` objects. .. seealso:: - `PList manual page `_ + `PList manual page `_ Apple's documentation of the file format. diff --git a/Doc/library/statistics.rst b/Doc/library/statistics.rst index f7bc7dfd0a0b33..bc3817836b9398 100644 --- a/Doc/library/statistics.rst +++ b/Doc/library/statistics.rst @@ -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 `_. - * The `SSMEDIAN `_ function in the Gnome Gnumeric spreadsheet, including `this discussion From 3f6344e70207d6f0f120bd4f2a94bb9552c26971 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Sun, 17 Dec 2017 22:55:57 +0530 Subject: [PATCH 16/19] Update link label in ssl.rst docs --- Doc/library/ssl.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index b898eaf26062db..6ee8da606ee632 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -868,7 +868,7 @@ Constants .. data:: HAS_NPN Whether the OpenSSL library has built-in support for *Next Protocol - Negotiation* as described in the `NPN draft specification + Negotiation* as described in the `Application Layer Protocol Negotiation `_. When true, you can use the :meth:`SSLContext.set_npn_protocols` method to advertise which protocols you want to support. @@ -1501,7 +1501,7 @@ to speed up repeated connections from the same clients. Specify which protocols the socket should advertise during the SSL/TLS 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 + handshake, and will play out according to the `Application Layer Protocol Negotiation `_. After a successful handshake, the :meth:`SSLSocket.selected_npn_protocol` method will return the agreed-upon protocol. From 3cd462f43a078d66699a7ff5f17ab76f721a8137 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Mon, 8 Jan 2018 00:23:12 +0530 Subject: [PATCH 17/19] Address review comments --- Doc/distutils/setupscript.rst | 2 +- Doc/faq/gui.rst | 2 +- Doc/howto/unicode.rst | 2 +- Doc/howto/urllib2.rst | 2 +- Doc/library/ast.rst | 2 +- Doc/library/colorsys.rst | 2 +- Doc/library/hashlib.rst | 4 ++-- Doc/library/mailbox.rst | 2 +- Doc/library/math.rst | 2 +- Doc/library/ssl.rst | 10 +++++----- Doc/library/tkinter.rst | 2 +- Doc/library/tkinter.ttk.rst | 2 +- Doc/library/unittest.mock-examples.rst | 2 +- Doc/library/urllib.request.rst | 2 +- Doc/library/venv.rst | 2 +- Doc/library/xml.dom.rst | 4 ++-- Doc/using/mac.rst | 2 +- Doc/using/unix.rst | 2 +- Doc/using/windows.rst | 4 ++-- Doc/whatsnew/2.2.rst | 4 ++-- Doc/whatsnew/2.3.rst | 4 ++-- Doc/whatsnew/2.5.rst | 2 +- Doc/whatsnew/2.7.rst | 2 +- Doc/whatsnew/3.2.rst | 2 +- 24 files changed, 33 insertions(+), 33 deletions(-) diff --git a/Doc/distutils/setupscript.rst b/Doc/distutils/setupscript.rst index 542ad544843fde..952607a4073b25 100644 --- a/Doc/distutils/setupscript.rst +++ b/Doc/distutils/setupscript.rst @@ -625,7 +625,7 @@ Notes: (7) The valid classifiers are listed on - `PyPI `_. + `PyPI `_. (8) To preserve backward compatibility, this field also accepts a string. If diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index 4f9979bf55ed3a..5eaff4b25d2bd2 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -65,7 +65,7 @@ PyQt is currently more mature than PySide, but you must buy a PyQt license from if you want to write proprietary applications. PySide is free for all applications. Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses -are available from `The Qt Company `_. +are available from `The Qt Company `_. Gtk+ ---- diff --git a/Doc/howto/unicode.rst b/Doc/howto/unicode.rst index a83e5a21895c2a..d4b8f8d2204ab7 100644 --- a/Doc/howto/unicode.rst +++ b/Doc/howto/unicode.rst @@ -214,7 +214,7 @@ difficult reading. `A chronology `_ of the origin and development of Unicode is also available on the site. To help understand the standard, Jukka Korpela has written `an introductory -guide `_ to reading the +guide `_ to reading the Unicode character tables. Another `good introductory article `_ diff --git a/Doc/howto/urllib2.rst b/Doc/howto/urllib2.rst index 8d383e03ee8a28..c1fd5cf0680d96 100644 --- a/Doc/howto/urllib2.rst +++ b/Doc/howto/urllib2.rst @@ -403,7 +403,7 @@ fetched, particularly the headers sent by the server. It is currently an :class:`http.client.HTTPMessage` instance. Typical headers include 'Content-length', 'Content-type', and so on. See the -`Quick Reference to HTTP Headers `_ +`Quick Reference to HTTP Headers `_ for a useful listing of HTTP headers with brief explanations of their meaning and use. diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst index bda46f46c43667..b7f610ba8b2a5f 100644 --- a/Doc/library/ast.rst +++ b/Doc/library/ast.rst @@ -261,5 +261,5 @@ and classes for traversing abstract syntax trees: .. seealso:: - `Green Tree Snakes `_, an external documentation resource, has good + `Green Tree Snakes `_, an external documentation resource, has good details on working with Python ASTs. diff --git a/Doc/library/colorsys.rst b/Doc/library/colorsys.rst index c33f531cc1d000..1360c7cc9f1db4 100644 --- a/Doc/library/colorsys.rst +++ b/Doc/library/colorsys.rst @@ -21,7 +21,7 @@ spaces, the coordinates are all between 0 and 1. .. seealso:: More information about color spaces can be found at - http://www.poynton.com/ColorFAQ.html and + http://poynton.ca/ColorFAQ.html and https://www.cambridgeincolour.com/tutorials/color-spaces.htm. The :mod:`colorsys` module defines the following functions: diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst index d4916914f79ce7..eda18adc9e5ec8 100644 --- a/Doc/library/hashlib.rst +++ b/Doc/library/hashlib.rst @@ -562,7 +562,7 @@ on the hash function used in digital signatures. by the signer. (`NIST SP-800-106 "Randomized Hashing for Digital Signatures" - `_) + `_) In BLAKE2 the salt is processed as a one-time input to the hash function during initialization, rather than as an input to each compression function. @@ -728,7 +728,7 @@ Domain Dedication 1.0 Universal: https://blake2.net Official BLAKE2 website. - http://csrc.nist.gov/publications/fips/fips180-2/fips180-2.pdf + https://csrc.nist.gov/csrc/media/publications/fips/180/2/archive/2002-08-01/documents/fips180-2.pdf The FIPS 180-2 publication on Secure Hash Algorithms. https://en.wikipedia.org/wiki/Cryptographic_hash_function#Cryptographic_hash_algorithms diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst index 81244c2ed02bd3..6bcaf034950d8c 100644 --- a/Doc/library/mailbox.rst +++ b/Doc/library/mailbox.rst @@ -620,7 +620,7 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF. `nmh - Message Handling System `_ Home page of :program:`nmh`, an updated version of the original :program:`mh`. - `MH & nmh: Email for Users & Programmers `_ + `MH & nmh: Email for Users & Programmers `_ A GPL-licensed book on :program:`mh` and :program:`nmh`, with some information on the mailbox format. diff --git a/Doc/library/math.rst b/Doc/library/math.rst index 9e4946323a9d37..55eb41b86f5d16 100644 --- a/Doc/library/math.rst +++ b/Doc/library/math.rst @@ -461,7 +461,7 @@ Constants Tau is a circle constant equal to 2\ *π*, the ratio of a circle's circumference to its radius. To learn more about Tau, check out Vi Hart's video `Pi is (still) Wrong `_, and start celebrating - `Tau day `_ by eating twice as much pie! + `Tau day `_ by eating twice as much pie! .. versionadded:: 3.6 diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index 6ee8da606ee632..b3cce048912bb4 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -1374,7 +1374,7 @@ to speed up repeated connections from the same clients. The *capath* string, if present, is the path to a directory containing several CA certificates in PEM format, following an `OpenSSL specific layout - `_. + `_. The *cadata* object, if present, is either an ASCII string of one or more PEM-encoded certificates or a :term:`bytes-like object` of DER-encoded @@ -1664,7 +1664,7 @@ to speed up repeated connections from the same clients. Get statistics about the SSL sessions created or managed by this context. A dictionary is returned which maps the names of each `piece of information - `_ to their + `_ to their numeric values. For example, here is the total number of hits and misses in the session cache since the context was created:: @@ -2365,7 +2365,7 @@ enabled when negotiating a SSL session is possible through the :meth:`SSLContext.set_ciphers` method. Starting from Python 3.2.3, the ssl module disables certain weak ciphers by default, but you may want to further restrict the cipher choice. Be sure to read OpenSSL's documentation -about the `cipher list format `_. +about the `cipher list format `_. If you want to check which ciphers are enabled by a given cipher list, use :meth:`SSLContext.get_ciphers` or the ``openssl ciphers`` command on your system. @@ -2393,10 +2393,10 @@ successful call of :func:`~ssl.RAND_add`, :func:`~ssl.RAND_bytes` or `RFC 1422: Privacy Enhancement for Internet Electronic Mail: Part II: Certificate-Based Key Management `_ Steve Kent - `RFC 4086: Randomness Requirements for Security `_ + `RFC 4086: Randomness Requirements for Security `_ Donald E., Jeffrey I. Schiller - `RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile `_ + `RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile `_ D. Cooper `RFC 5246: The Transport Layer Security (TLS) Protocol Version 1.2 `_ diff --git a/Doc/library/tkinter.rst b/Doc/library/tkinter.rst index f222fe6f8b2053..6d90e43e33b266 100644 --- a/Doc/library/tkinter.rst +++ b/Doc/library/tkinter.rst @@ -35,7 +35,7 @@ this should open a window demonstrating a simple Tk interface. `Tcl/Tk manual `_ Official manual for the latest tcl/tk version. - `Programming Python `_ + `Programming Python `_ Book by Mark Lutz, has excellent coverage of Tkinter. `Modern Tkinter for Busy Python Developers `_ diff --git a/Doc/library/tkinter.ttk.rst b/Doc/library/tkinter.ttk.rst index 927f7f3c6c1b71..debbc81ce1a390 100644 --- a/Doc/library/tkinter.ttk.rst +++ b/Doc/library/tkinter.ttk.rst @@ -26,7 +26,7 @@ appearance. .. seealso:: - `Tk Widget Styling Support `_ + `Tk Widget Styling Support `_ A document introducing theming support for Tk diff --git a/Doc/library/unittest.mock-examples.rst b/Doc/library/unittest.mock-examples.rst index 20f35c2f8cab50..5bf3d575520e49 100644 --- a/Doc/library/unittest.mock-examples.rst +++ b/Doc/library/unittest.mock-examples.rst @@ -1251,7 +1251,7 @@ With a bit of tweaking you could have the comparison function raise the :exc:`AssertionError` directly and provide a more useful failure message. As of version 1.5, the Python testing library `PyHamcrest -`_ provides similar functionality, +`_ provides similar functionality, that may be useful here, in the form of its equality matcher (`hamcrest.library.integration.match_equality `_). diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst index 5a10f9571e9e87..413d8b6ffdfe0a 100644 --- a/Doc/library/urllib.request.rst +++ b/Doc/library/urllib.request.rst @@ -62,7 +62,7 @@ The :mod:`urllib.request` module defines the following functions: * :meth:`~urllib.response.addinfourl.info` --- return the meta-information of the page, such as headers, in the form of an :func:`email.message_from_string` instance (see - `Quick Reference to HTTP Headers `_) + `Quick Reference to HTTP Headers `_) * :meth:`~urllib.response.addinfourl.getcode` -- return the HTTP status code of the response. diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index 17c80c8d982c0c..6707be7fc820dd 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -458,4 +458,4 @@ subclass which installs setuptools and pip into a created virtual environment:: This script is also available for download `online -`_. +`_. diff --git a/Doc/library/xml.dom.rst b/Doc/library/xml.dom.rst index de334af2363926..18519a75a54611 100644 --- a/Doc/library/xml.dom.rst +++ b/Doc/library/xml.dom.rst @@ -67,13 +67,13 @@ implementations are free to support the strict mapping from IDL). See section .. seealso:: - `Document Object Model (DOM) Level 2 Specification `_ + `Document Object Model (DOM) Level 2 Specification `_ The W3C recommendation upon which the Python DOM API is based. `Document Object Model (DOM) Level 1 Specification `_ The W3C recommendation for the DOM supported by :mod:`xml.dom.minidom`. - `Python Language Mapping Specification `_ + `Python Language Mapping Specification `_ This specifies the mapping from OMG IDL to Python. diff --git a/Doc/using/mac.rst b/Doc/using/mac.rst index f37c34f5ddd073..a386728eaee306 100644 --- a/Doc/using/mac.rst +++ b/Doc/using/mac.rst @@ -117,7 +117,7 @@ The IDE MacPython ships with the standard IDLE development environment. A good introduction to using IDLE can be found at -https://hkn.eecs.berkeley.edu/~dyoo/python/idle_intro/index.html. +http://www.hashcollision.org/hkn/python/idle_intro/index.html. .. _mac-package-manager: diff --git a/Doc/using/unix.rst b/Doc/using/unix.rst index 8b96ebea396fb6..ccdf84dcfa5eda 100644 --- a/Doc/using/unix.rst +++ b/Doc/using/unix.rst @@ -30,7 +30,7 @@ following links: for Debian users https://en.opensuse.org/Portal:Packaging for OpenSuse users - https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch-creating-rpms.html + https://docs-old.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/RPM_Guide/ch-creating-rpms.html for Fedora users http://www.slackbook.org/html/package-management-making-packages.html for Slackware users diff --git a/Doc/using/windows.rst b/Doc/using/windows.rst index 14166bed5b5395..1c7b8142af29e0 100644 --- a/Doc/using/windows.rst +++ b/Doc/using/windows.rst @@ -307,11 +307,11 @@ key features: `ActivePython `_ Installer with multi-platform compatibility, documentation, PyWin32 -`Anaconda `_ +`Anaconda `_ Popular scientific modules (such as numpy, scipy and pandas) and the ``conda`` package manager. -`Canopy `_ +`Canopy `_ A "comprehensive Python analysis environment" with editors and other development tools. diff --git a/Doc/whatsnew/2.2.rst b/Doc/whatsnew/2.2.rst index a0bb81a9748663..74f3087b5632c0 100644 --- a/Doc/whatsnew/2.2.rst +++ b/Doc/whatsnew/2.2.rst @@ -635,7 +635,7 @@ 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 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 like:: sentence := "Store it in the neighboring harbor" @@ -957,7 +957,7 @@ New and Improved Modules # 'title': 'html2fo 0.3 (Default)'}, ... ] The :mod:`SimpleXMLRPCServer` module makes it easy to create straightforward - XML-RPC servers. See http://www.xmlrpc.com/ for more information about XML-RPC. + XML-RPC servers. See http://xmlrpc.scripting.com/ for more information about XML-RPC. * The new :mod:`hmac` module implements the HMAC algorithm described by :rfc:`2104`. (Contributed by Gerhard Häring.) diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index 6bd8f467b0f0d4..19c034391d18e5 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -218,7 +218,7 @@ 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://www2.cs.arizona.edu/icon/), where the idea of generators is central. In +(https://wwww.cs.arizona.edu/icon/), where the idea of generators is central. In Icon, every expression and function call behaves like a generator. One example from "An Overview of the Icon Programming Language" at https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks @@ -1955,7 +1955,7 @@ The RPM spec files, found in the :file:`Misc/RPM/` directory in the Python source distribution, were updated for 2.3. (Contributed by Sean Reifschneider.) Other new platforms now supported by Python include AtheOS -(http://atheos.cx/), GNU/Hurd, and OpenVMS. +(http://www.atheos.cx/), GNU/Hurd, and OpenVMS. .. ====================================================================== diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst index 4d482918313239..15d35d384c4046 100644 --- a/Doc/whatsnew/2.5.rst +++ b/Doc/whatsnew/2.5.rst @@ -330,7 +330,7 @@ statement, only the ``from ... import`` form. :pep:`328` - Imports: Multi-Line and Absolute/Relative PEP written by Aahz; implemented by Thomas Wouters. - https://pylib.readthedocs.org/ + https://pylib.readthedocs.io/ The py library by Holger Krekel, which contains the :mod:`py.std` package. .. ====================================================================== diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst index eec8984539573c..90ce06c328685c 100644 --- a/Doc/whatsnew/2.7.rst +++ b/Doc/whatsnew/2.7.rst @@ -1545,7 +1545,7 @@ changes, or look through the Subversion logs for all the details. *ciphers* argument that's a string listing the encryption algorithms to be allowed; the format of the string is described `in the OpenSSL documentation - `__. + `__. (Added by Antoine Pitrou; :issue:`8322`.) Another change makes the extension load all of OpenSSL's ciphers and diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst index 78d3105a5a410b..2d740006a3706a 100644 --- a/Doc/whatsnew/3.2.rst +++ b/Doc/whatsnew/3.2.rst @@ -1643,7 +1643,7 @@ for secure (encrypted, authenticated) internet connections: * The :func:`ssl.wrap_socket` constructor function now takes a *ciphers* argument. The *ciphers* string lists the allowed encryption algorithms using the format described in the `OpenSSL documentation - `__. + `__. * When linked against recent versions of OpenSSL, the :mod:`ssl` module now supports the Server Name Indication extension to the TLS protocol, allowing From 353d5bc4e5d576ffb2dc2135a62099b71c3d8696 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Thu, 18 Jan 2018 00:14:27 +0530 Subject: [PATCH 18/19] Fix issues in ssl.rst docs --- Doc/library/ssl.rst | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst index badf1be3dddd57..4c44ffa23ac8d6 100644 --- a/Doc/library/ssl.rst +++ b/Doc/library/ssl.rst @@ -868,9 +868,9 @@ Constants .. data:: HAS_NPN Whether the OpenSSL library has built-in support for *Next Protocol - Negotiation* as described in the `Application Layer Protocol Negotiation - `_. When true, - you can use the :meth:`SSLContext.set_npn_protocols` method to advertise + Negotiation* as described in the `Application Layer Protocol + Negotiation `_. + When true, you can use the :meth:`SSLContext.set_npn_protocols` method to advertise which protocols you want to support. .. versionadded:: 3.3 @@ -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 `Application Layer Protocol Negotiation - `_. After a + `_. After a successful handshake, the :meth:`SSLSocket.selected_npn_protocol` method will return the agreed-upon protocol. @@ -1663,12 +1663,7 @@ to speed up repeated connections from the same clients. .. method:: SSLContext.session_stats() Get statistics about the SSL sessions created or managed by this context. - A dictionary is returned which maps the names of each `piece of information -<<<<<<< HEAD - `_ to their -======= - `_ to their ->>>>>>> master + A dictionary is returned which maps the names of each `piece of information `_ to their numeric values. For example, here is the total number of hits and misses in the session cache since the context was created:: From ceb3581eb34c2e4732ff3bbf56e8245213a12b42 Mon Sep 17 00:00:00 2001 From: Sanyam Khurana Date: Fri, 19 Jan 2018 22:42:10 +0530 Subject: [PATCH 19/19] bpo-25910: Address review comments --- Doc/faq/gui.rst | 2 +- Doc/library/wsgiref.rst | 2 +- Doc/whatsnew/2.2.rst | 2 +- Doc/whatsnew/2.3.rst | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index 5eaff4b25d2bd2..4f9979bf55ed3a 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -65,7 +65,7 @@ PyQt is currently more mature than PySide, but you must buy a PyQt license from if you want to write proprietary applications. PySide is free for all applications. Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses -are available from `The Qt Company `_. +are available from `The Qt Company `_. Gtk+ ---- diff --git a/Doc/library/wsgiref.rst b/Doc/library/wsgiref.rst index 57a2d2e86708be..b0ef3465b04fab 100644 --- a/Doc/library/wsgiref.rst +++ b/Doc/library/wsgiref.rst @@ -26,7 +26,7 @@ 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 wsgi.readthedocs.io _ for more information about WSGI, and links +See `wsgi.readthedocs.io `_ for more information about WSGI, and links to tutorials and other resources. .. XXX If you're just trying to write a web application... diff --git a/Doc/whatsnew/2.2.rst b/Doc/whatsnew/2.2.rst index 74f3087b5632c0..0aa6003f4c46d8 100644 --- a/Doc/whatsnew/2.2.rst +++ b/Doc/whatsnew/2.2.rst @@ -635,7 +635,7 @@ 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 Icon, every expression and function call behaves like a generator. One example from "An Overview of the Icon Programming Language" at -https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks +https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks like:: sentence := "Store it in the neighboring harbor" diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index 19c034391d18e5..b5628a910ae86f 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -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://wwww.cs.arizona.edu/icon/), where the idea of generators is central. In +(https://www.cs.arizona.edu/icon/), where the idea of generators is central. In Icon, every expression and function call behaves like a generator. One example from "An Overview of the Icon Programming Language" at -https://www2.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks +https://www.cs.arizona.edu/icon/docs/ipd266.htm gives an idea of what this looks like:: sentence := "Store it in the neighboring harbor"