Skip to content

Commit

Permalink
✏️ Switch to pep role
Browse files Browse the repository at this point in the history
  • Loading branch information
veit committed Apr 22, 2023
1 parent 7890a35 commit d400453
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 28 deletions.
3 changes: 1 addition & 2 deletions docs/data-processing/postgresql/db-api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,4 @@ Cursor
print(column1, column2)

.. seealso::
`PEP 249 – Python Database API Specification v2.0
<https://www.python.org/dev/peps/pep-0249/>`_
:pep:`249` – Python Database API Specification v2.0
14 changes: 7 additions & 7 deletions docs/performance/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,13 +186,13 @@ Faster Cpython
At PyCon US in May 2021, Guido van Rossum presented `Faster CPython
<https://github.com/faster-cpython>`_, a project that aims to double the speed
of Python 3.11. The cooperation with the other Python core developers is
regulated in `PEP 659 – Specializing Adaptive Interpreter
<https://peps.python.org/pep-0659/>`_. There is also an open `issue tracker
<https://github.com/faster-cpython/ideas/issues>`_ and various `tools for
collecting bytecode statistics <https://github.com/faster-cpython/tools>`_.
CPU-intensive Python code in particular is likely to benefit from the changes;
code already written in C, I/O-heavy processes and multithreaded code, on the
other hand, are unlikely to benefit.
regulated in :pep:`PEP 659 – Specializing Adaptive Interpreter <659>`. There is
also an open `issue tracker <https://github.com/faster-cpython/ideas/issues>`_
and various `tools for collecting bytecode statistics
<https://github.com/faster-cpython/tools>`_. CPU-intensive Python code in
particular is likely to benefit from the changes; code already written in C,
I/O-heavy processes and multithreaded code, on the other hand, are unlikely to
benefit.

.. seealso::
* `Faster CPython <https://faster-cpython.readthedocs.io/>`__
Expand Down
5 changes: 2 additions & 3 deletions docs/productive/envs/pipenv/use.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,8 @@ Options
``check``
---------

``pipenv check`` checks for security holes and for `PEP 508
<https://www.python.org/dev/peps/pep-0508/>` markers in the pipfile. For this it
uses `safety <https://github.com/pyupio/safety>`_.
``pipenv check`` checks for security holes and for :pep:`508` markers in the pip
ile. For this it uses `safety <https://github.com/pyupio/safety>`_.

Example:

Expand Down
3 changes: 1 addition & 2 deletions docs/productive/git/hooks/hooks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@ Python Code Quality Authority
static analysis tool to check compliance with Python docstring
conventions
`docformatter <https://github.com/PyCQA/docformatter>`_
formats docstrings according to `PEP 257
<https://peps.python.org/pep-0257/>`_
formats docstrings according to :pep:`257`
`pylint <https://github.com/PyCQA/pylint>`_
Python linter
`doc8 <https://github.com/PyCQA/doc8>`_
Expand Down
9 changes: 3 additions & 6 deletions docs/productive/licensing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -333,9 +333,6 @@ classifications with `trove-classifiers
<https://github.com/pypa/trove-classifiers>`_.

.. seealso::
* `PEP 639 – Improving License Clarity with Better Package Metadata
<https://peps.python.org/pep-0639/>`_
* `PEP 621 – Storing project metadata in pyproject.toml
<https://peps.python.org/pep-0621/>`_
* `PEP 643 – Metadata for Package Source Distributions
<https://peps.python.org/pep-0643/>`_
* :pep:`639` – Improving License Clarity with Better Package Metadata
* :pep:`621` – Storing project metadata in pyproject.toml
* :pep:`643` – Metadata for Package Source Distributions
5 changes: 2 additions & 3 deletions docs/productive/logging/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ Logging
=======

The `logging <https://docs.python.org/3/library/logging.html#module-logging>`_
module is part of the Python standard library. It is described in `PEP 0282
<https://www.python.org/dev/peps/pep-0282>`_. You can get a first introduction
to the module in the `Basic Logging Tutorial
module is part of the Python standard library. It is described in :pep:`0282`.r
You can get a first introduction to the module in the `Basic Logging Tutorial
<https://docs.python.org/3/howto/logging.html#logging-basic-tutorial>`_.

Logging usually serves two different purposes:
Expand Down
2 changes: 1 addition & 1 deletion docs/productive/qa/anti-patterns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Nested Dicts [#]_. Data classes save you from writing and managing these
methods.

.. seealso::
* `PEP 557 – Data Classes <https://peps.python.org/pep-0557/>`_
* :pep:`557` – Data Classes

`attrs <https://www.attrs.org/en/stable/>`_ is a Python package that has been
around much longer than ``dataclasses``, is more comprehensive and can also be
Expand Down
5 changes: 2 additions & 3 deletions docs/productive/qa/flake8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
==========

`flake8 <https://pypi.org/project/flake8/>`_ ensures that most of your code
follows `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_. However, automatic
formatting, for example with :doc:`black`, is even more convenient. In addition
``flake8`` also checks for unused imports.
follows :pep:`8`. However, automatic formatting, for example with :doc:`black`,
is even more convenient. In addition ``flake8`` also checks for unused imports.

Installation
------------
Expand Down
2 changes: 1 addition & 1 deletion docs/productive/qa/wily.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ can also specify other references, for example ``HEAD^1`` with
----

.. [#] `PEP 20 – The Zen of Python <https://www.python.org/dev/peps/pep-0020/>`_
.. [#] :pep:`20` – The Zen of Python
.. [#] `C4 Software Technology Reference Guide, S. 147
<https://resources.sei.cmu.edu/asset_files/Handbook/1997_002_001_16523.pdf>`_
.. [#] `Using Metrics to Evaluate Software System Maintainability
Expand Down

0 comments on commit d400453

Please sign in to comment.