Skip to content

Commit

Permalink
Python Style Guide (#480)
Browse files Browse the repository at this point in the history
* added styleguide for python code

* fix typos

* updated docstring format
  • Loading branch information
alexsu52 authored Feb 5, 2021
1 parent 3b6847c commit 0e06d6c
Show file tree
Hide file tree
Showing 2 changed files with 823 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ If your testing code is more extensive than unit tests (in terms of test executi


## Code style
Changes to NNCF Python code should conform to [Python Style Guide](./docs/styleguide/PyGuide.md)

Pylint is used throughout the project to ensure code cleanliness and quality.
A Pylint run is also done as part of the pre-commit scope - the pre-commit `pytest` scope will not be run if your code fails the Pylint checks.
The Pylint rules and exceptions for this repository are described in the standard [.pylintrc](./.pylintrc) format - make sure your local linter uses these.
Expand Down
Loading

0 comments on commit 0e06d6c

Please sign in to comment.