Skip to content

Commit

Permalink
[refs #24] Adding a link to the profile documentation to the main README
Browse files Browse the repository at this point in the history
  • Loading branch information
carlio committed Oct 3, 2014
1 parent 6a65c31 commit 11ba287
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ Run `prospector --help` for a full list of options and their effects.

The default output format of `prospector` is designed to be human readable. For parsing (for example, for reporting), you can use the `--output-format json` flag to get JSON-formatted output.

### Profiles

Prospector is configurable using "profiles". These are composable YAML files with directives to
disable or enable tools or messages. For more information, read [the documentation about profiles](http://prospector.readthedocs.org/en/latest/profiles.html)

### If your code uses frameworks and libraries

Often tools such as pylint find errors in code which is not an error, due to, for example, 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.
Expand Down

0 comments on commit 11ba287

Please sign in to comment.