Skip to content

Commit

Permalink
Fix references to old landscapeio repo in docs
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Coelho <carlospecter@gmail.com>
  • Loading branch information
chocoelho committed Dec 4, 2018
1 parent 8bb1970 commit 30b385a
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 40 deletions.
6 changes: 3 additions & 3 deletions docs/contrib.rst
Expand Up @@ -10,8 +10,8 @@ All contributions are very welcome! You can contribute in many ways:
* Submit pull requests on the GitHub `repository`_. Ideally make a pull request to the *develop* branch, as I prefer to keep the master branch the same as the most recent release on PyPI. If you do this, be sure to add yourself to the CONTRIBUTORS.md file too!

.. _python code quality: https://mail.python.org/mailman/listinfo/code-quality
.. _issue tracker: https://github.com/landscapeio/prospector/issues
.. _repository: https://github.com/landscapeio/prospector
.. _issue tracker: https://github.com/PyCQA/prospector/issues
.. _repository: https://github.com/PyCQA/prospector


Code Quality
Expand Down Expand Up @@ -41,4 +41,4 @@ Prospector targets Python 2.7, 3.3, 3.4, 3.5 and 3.6. You can use `tox`_ to test
and all tests are run on `travis-ci.org`_.

.. _tox: https://tox.readthedocs.io/en/latest/
.. _travis-ci.org: https://travis-ci.org/landscapeio/prospector
.. _travis-ci.org: https://travis-ci.org/PyCQA/prospector
30 changes: 15 additions & 15 deletions docs/index.rst
Expand Up @@ -23,14 +23,14 @@ 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`_, `pep8`_, and `McCabe complexity`_.
It brings together the functionality of other Python analysis tools such as `Pylint`_, `pep8`_, and `McCabe complexity`_.
See the :doc:`Supported Tools<supported_tools>` section for a complete list.

The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other
Python analysis tools is that it takes a long time to filter through which errors are relevant
or interesting to your own coding style. Prospector provides some default profiles, which
hopefully will provide a good starting point and will be useful straight away,
and adapts the output depending on the libraries your project uses.
The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other
Python analysis tools is that it takes a long time to filter through which errors are relevant
or interesting to your own coding style. Prospector provides some default profiles, which
hopefully will provide a good starting point and will be useful straight away,
and adapts the output depending on the libraries your project uses.

.. _pylint: https://pylint.readthedocs.io/
.. _pep8: https://pep8.readthedocs.io/
Expand Down Expand Up @@ -82,25 +82,25 @@ Adapting to Dependencies

Prospector will `try to detect <https://github.com/landscapeio/requirements-detector>`_ the
libraries that your project uses, and adapt the output and filtering to those libraries.
For example, if you use Django, the
`pylint-django <https://github.com/landscapeio/pylint-django>`_ plugin will be loaded
For example, if you use Django, the
`pylint-django <https://github.com/PyCQA/pylint-django>`_ plugin will be loaded
to help Pylint inspect Django-specific code.

There is currently support for the following frameworks:

- `Celery <https://github.com/landscapeio/pylint-celery>`_
- `Django <https://github.com/landscapeio/pylint-django>`_
- `Celery <https://github.com/PyCQA/pylint-celery>`_
- `Django <https://github.com/PyCQA/pylint-django>`_
- `Flask <https://github.com/jschaf/pylint-flask>`_

If you have a suggestion for another framework or library which should be supported,
please `add an issue <https://github.com/landscapeio/prospector/issues>`_
If you have a suggestion for another framework or library which should be supported,
please `add an issue <https://github.com/PyCQA/prospector/issues>`_
or :doc:`consider creating a pull request <contrib>`.


Strictness
``````````

Prospector can be configured to be more or less strict. The more strict, the more errors and
Prospector can be configured to be more or less strict. The more strict, the more errors and
warnings it will find. At higher strictness levels, you may find that the output is a bit too
picky. The default level is designed to give useful output and warnings but also to suppress
messages which are not necessarily useful.
Expand All @@ -109,7 +109,7 @@ To change the strictness level::

prospector --strictness high

Valid levels are ``verylow``, ``low``, ``medium``, ``high`` and ``veryhigh``.
Valid levels are ``verylow``, ``low``, ``medium``, ``high`` and ``veryhigh``.


Profiles
Expand All @@ -122,7 +122,7 @@ project.

Note that the 'strictness' is implemented as a profile.

There is more detail about profiles and how to use them on
There is more detail about profiles and how to use them on
:doc:`the profiles documentation <profiles>` page.


Expand Down
24 changes: 12 additions & 12 deletions docs/profiles.rst
Expand Up @@ -25,7 +25,7 @@ in profiles.
Profile Path
------------

The name of a profile is the filename without the ``.yaml`` extension. So if you create
The name of a profile is the filename without the ``.yaml`` extension. So if you create
a profile called 'my_project.yaml', the name will be 'my_project'. Inheritance works
by searching the ``profile-path`` for files matching the name in the inheritance list.

Expand All @@ -45,7 +45,7 @@ Example
-------

Here is an example profile::

output-format: json

strictness: medium
Expand Down Expand Up @@ -78,7 +78,7 @@ Builtin Profiles
----------------

Prospector comes with several built-in profiles, which power some of strictness and style
options. You can see the `full list on GitHub <https://github.com/landscapeio/prospector/tree/master/prospector/profiles/profiles>`_.
options. You can see the `full list on GitHub <https://github.com/PyCQA/prospector/tree/master/prospector/profiles/profiles>`_.


.. _strictness:
Expand Down Expand Up @@ -172,7 +172,7 @@ Libraries Used and Autodetect
.............................

Prospector will adjust the behaviour of the underlying tools based on the libraries that your project
uses. If you use Django, for example, the `pylint-django <https://github.com/landscapeio/pylint-django>`_ plugin
uses. If you use Django, for example, the `pylint-django <https://github.com/PyCQA/pylint-django>`_ plugin
will be loaded. This will happen automatically.

If prospector is not correctly determining which of its supported libraries you use, you can specify
Expand All @@ -194,9 +194,9 @@ If prospector is incorrectly deciding that you use one of these, you can turn of
Inheritance
-----------

Profiles can inherit from other profiles, and can inherit from more than one profile.
Profiles can inherit from other profiles, and can inherit from more than one profile.
Prospector merges together all of the options in each profile, starting at the top
of the inheritance tree and overwriting values with those found lower.
of the inheritance tree and overwriting values with those found lower.

The example profile above inherits from another profile provided by the user,
``my/other/profile.yml``. This allows you to have, for example, a project wide
Expand All @@ -209,7 +209,7 @@ there are shortcuts for most of the built-ins, see below.::
- strictness_medium
- full_pep8

For lists, such as the ``ignore`` section, they will be merged together rather than
For lists, such as the ``ignore`` section, they will be merged together rather than
overwritten - so essentially, the ``ignore`` section will accumulate.

The profile named in the ``inherits`` section must be on the :ref:`profile path <profile_path>`.
Expand Down Expand Up @@ -247,9 +247,9 @@ your profile if you are using it.
Tool Configuration
------------------

Each tool can be individually configured with a section beginning with the tool name
(in lowercase). Valid values are
``pylint``, ``pep8``, ``mccabe``, ``dodgy``, ``pyflakes``, ``frosted``,
Each tool can be individually configured with a section beginning with the tool name
(in lowercase). Valid values are
``pylint``, ``pep8``, ``mccabe``, ``dodgy``, ``pyflakes``, ``frosted``,
``vulture`` and ``pyroma``.

Enabling and Disabling Tools
Expand All @@ -271,8 +271,8 @@ Enabling and Disabling Messages

Messages can be enabled or disabled using the tool's code for the output. These codes are
either from the tool itself, or provided by prospector for those tools which do not have
message codes. The list of tools and message codes can be found
`in the tools package <https://github.com/landscapeio/prospector/tree/master/prospector/tools>`_.
message codes. The list of tools and message codes can be found
`in the tools package <https://github.com/PyCQA/prospector/tree/master/prospector/tools>`_.

The typical desired action is to disable messages::

Expand Down
20 changes: 10 additions & 10 deletions docs/usage.rst
@@ -1,7 +1,7 @@
Command Line Usage
==================

.. _issue_16: https://github.com/landscapeio/prospector/issues/16
.. _issue_16: https://github.com/PyCQA/prospector/issues/16
.. _vscode_python_plugin: https://marketplace.visualstudio.com/items?itemName=donjayamanne.python
The simplest way to run prospector is from the project root with no arguments. It will try to figure everything else out itself and provide sensible defaults::

Expand Down Expand Up @@ -54,18 +54,18 @@ The default output format of ``prospector`` is designed to be human readable. Yo
If your code uses frameworks and libraries
''''''''''''''''''''''''''''''''''''''''''

Often tools such as pylint find errors in code which is not an error, due to attributes of
classes being created at run time by a library or framework used by
your project. For example, by default, pylint will generate an error for Django
models when accessing ``objects``, as the ``objects`` attribute is not part of the ``Model``
class definition.
Often tools such as pylint find errors in code which is not an error, due to attributes of
classes being created at run time by a library or framework used by
your project. For example, by default, pylint will generate an error for Django
models when accessing ``objects``, as the ``objects`` attribute is not part of the ``Model``
class definition.

Prospector mitigates this by providing an understanding of these frameworks to the underlying
Prospector mitigates this by providing an understanding of these frameworks to the underlying
tools.

Prospector will try to intuit which libraries your project uses by
`detecting dependencies <https://github.com/landscapeio/requirements-detector>`
and automatically turning on support for the requisite libraries. You can see which adaptors
Prospector will try to intuit which libraries your project uses by
`detecting dependencies <https://github.com/landscapeio/requirements-detector>`
and automatically turning on support for the requisite libraries. You can see which adaptors
were run in the metadata section of the report.

If Prospector does not correctly detect your project's dependencies, you can specify them manually from the commandline::
Expand Down

0 comments on commit 30b385a

Please sign in to comment.