Skip to content

Commit

Permalink
Merge pull request #236 from tnir/235-docs-typo
Browse files Browse the repository at this point in the history
Fix typo and update URLs in docs
  • Loading branch information
chocoelho authored May 26, 2018
2 parents 6a15eea + 2926da0 commit c914dfb
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ BUILDDIR = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://www.sphinx-doc.org/)
endif

# Internal variables.
Expand Down
6 changes: 3 additions & 3 deletions docs/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ handling the output of other tools. However, please do run them before submittin
nosetests tests/

Prospector targets Python 2.7, 3.3, 3.4, 3.5 and 3.6. You can use `tox`_ to test this locally,
and all tests are run on `travis.org`_.
and all tests are run on `travis-ci.org`_.

.. _tox: https://tox.readthedocs.org/en/latest/
.. _travis.org: https://travis-ci.org/landscapeio/prospector
.. _tox: https://tox.readthedocs.io/en/latest/
.. _travis-ci.org: https://travis-ci.org/landscapeio/prospector
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ About
Prospector is a tool to analyse Python code and output information about errors, potential problems, convention violations and complexity.

It brings together the functionality of other Python analysis tools such as
`Pylint <http://docs.pylint.org/>`_,
`pep8 <http://pep8.readthedocs.org/en/latest/>`_,
`Pylint <https://pylint.readthedocs.io/>`_,
`pep8 <https://pep8.readthedocs.io/>`_,
and `McCabe complexity <https://pypi.python.org/pypi/mccabe>`_.
See the :doc:`Supported Tools<supported_tools>` section for a complete list.

Expand Down
2 changes: 1 addition & 1 deletion docs/profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,4 +307,4 @@ The available options are:
+-----------+------------------+----------------------------------------------+


.. _pylint options: http://docs.pylint.org/features.html#options
.. _pylint options: https://pylint.readthedocs.io/en/latest/user_guide/run.html
8 changes: 4 additions & 4 deletions docs/supported_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ To run the default tools but turn off one or two defaults::
Defaults
--------

`Pylint <http://www.pylint.org>`_
`Pylint <https://www.pylint.org>`_
`````````````````````````````````
Pylint is the most comprehensive static analysis tool for Python. It is extremely thorough
and is the source of most messages that prospector outputs.


`pep8.py <http://pep8.readthedocs.org/en/latest/>`_
`pep8.py <https://pep8.readthedocs.io/>`_
```````````````````````````````````````````````````

``pep8.py`` is a simple tool to warn about violations of the
`PEP8 style guide <http://legacy.python.org/dev/peps/pep-0008/>`_. It produces
`PEP8 style guide <https://www.python.org/dev/peps/pep-0008/>`_. It produces
messages for any divergence from the style guide.

Prospector's concept of :doc:`strictness <profiles>` turns off various warnings
Expand Down Expand Up @@ -64,7 +64,7 @@ than pylint, but also not as thorough.

`mccabe <https://github.com/PyCQA/mccabe>`_
```````````````````````````````````````````````
`McCabe or cyclomatic complexity <http://en.wikipedia.org/wiki/Cyclomatic_complexity>`_ is
`McCabe or cyclomatic complexity <https://en.wikipedia.org/wiki/Cyclomatic_complexity>`_ is
a measurement of how many paths there are in a given function or method. It measures how
complicated your functions are, and warns if they reach a certain threshold. Methods that
are too complex are prone to logic errors, and should be refactored to a series of smaller
Expand Down

0 comments on commit c914dfb

Please sign in to comment.