Skip to content

Commit b45eb2b

Browse files
bingyaojnothman
authored andcommittedAug 1, 2019
DOC: Update links and code checkers info. (#228)
1 parent 9315c66 commit b45eb2b

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed
 

‎doc/format.rst

+23-16
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ numpydoc docstring guide
88
.. Contents::
99

1010
This document describes the syntax and best practices for docstrings used with
11-
the numpydoc extension for `Sphinx <http://sphinx-doc.org/>`__.
11+
the numpydoc extension for Sphinx_.
1212

1313
.. Note::
1414

@@ -21,21 +21,23 @@ the numpydoc extension for `Sphinx <http://sphinx-doc.org/>`__.
2121
Overview
2222
--------
2323
We mostly follow the standard Python style conventions as described here:
24-
* `Style Guide for C Code <http://python.org/dev/peps/pep-0007/>`_
25-
* `Style Guide for Python Code <http://python.org/dev/peps/pep-0008/>`_
26-
* `Docstring Conventions <http://python.org/dev/peps/pep-0257/>`_
24+
* `Style Guide for C Code <https://www.python.org/dev/peps/pep-0007/>`_
25+
* `Style Guide for Python Code <https://www.python.org/dev/peps/pep-0008/>`_
26+
* `Docstring Conventions <https://www.python.org/dev/peps/pep-0257/>`_
2727

2828
Additional PEPs of interest regarding documentation of code:
29-
* `Docstring Processing Framework <http://python.org/dev/peps/pep-0256/>`_
30-
* `Docutils Design Specification <http://python.org/dev/peps/pep-0258/>`_
29+
* `Docstring Processing Framework <https://www.python.org/dev/peps/pep-0256/>`_
30+
* `Docutils Design Specification <https://www.python.org/dev/peps/pep-0258/>`_
3131

3232
Use a code checker:
33-
* `pylint <http://www.logilab.org/857>`_
34-
* `pyflakes <https://pypi.python.org/pypi/pyflakes>`_
35-
* `pep8.py <http://svn.browsershots.org/trunk/devtools/pep8/pep8.py>`_
36-
* `flake8 <https://pypi.python.org/pypi/flake8>`_
37-
* `vim-flake8 <https://github.com/nvie/vim-flake8>`_ plugin for
38-
automatically checking syntax and style with flake8
33+
* pylint_: a Python static code analysis tool.
34+
* pyflakes_: a tool to check Python code for errors by parsing
35+
the source file instead of importing it.
36+
* pycodestyle_: (formerly ``pep8``) a tool to check Python code against
37+
some of the style conventions in PEP 8.
38+
* flake8_: a tool that glues together ``pycodestyle``, ``pyflakes``,
39+
``mccabe`` to check the style and quality of Python code.
40+
* vim-flake8_: a ``flake8`` plugin for Vim.
3941

4042
Import conventions
4143
------------------
@@ -332,7 +334,7 @@ The sections of a function's docstring are:
332334
An optional section that provides additional information about the
333335
code, possibly including a discussion of the algorithm. This
334336
section may include mathematical equations, written in
335-
`LaTeX <http://www.latex-project.org/>`_ format::
337+
`LaTeX <https://www.latex-project.org/>`_ format::
336338

337339
The FFT is a fast implementation of the discrete Fourier transform:
338340

@@ -686,6 +688,11 @@ Conclusion
686688
This document itself was written in ReStructuredText.
687689
:ref:`An example <example>` of the format shown here is available.
688690

689-
.. _SciPy: http://www.scipy.org
690-
.. _numpy-discussion list: http://scipy.org/scipylib/mailing-lists.html
691-
.. _Sphinx: http://sphinx.pocoo.org
691+
.. _Sphinx: https://www.sphinx-doc.org/
692+
.. _pylint: https://pypi.org/project/pylint/
693+
.. _pyflakes: https://pypi.python.org/pypi/pyflakes/
694+
.. _pycodestyle: https://pypi.org/project/pycodestyle/
695+
.. _flake8: https://pypi.python.org/pypi/flake8/
696+
.. _vim-flake8: https://github.com/nvie/vim-flake8
697+
.. _SciPy: https://www.scipy.org
698+
.. _numpy-discussion list: https://scipy.org/scipylib/mailing-lists.html

0 commit comments

Comments
 (0)
Please sign in to comment.