Skip to content

Commit b480ab0

Browse files
authored
Merge pull request #170 from fooof-tools/docs
[DOC] Update Sphinx & misc doc related things
2 parents 44824ae + c3e9a5b commit b480ab0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+1459
-960
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ FOOOF follows the following conventions:
5252
- Code style should follow [PEP8](https://www.python.org/dev/peps/pep-0008/)
5353
- Merge candidate code will be checked using [pylint](https://www.pylint.org)
5454
- Max line length is 100 characters
55-
- All functions should be unit tested, using [pytest](https://docs.pytest.org/en/latest/)
55+
- All functions should be tested, using [pytest](https://docs.pytest.org/en/latest/)
5656
- Merge candidates must pass all existing tests, and add new tests such as to not reduce test coverage
5757
- All code should be documented, following the [numpy docs](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) format
58+
- Example sections in docstrings are recommended, if possible.
59+
- If so, these examples should be executable (through doctest), or use the SKIP directive if they cannot be run
5860

5961
For more guidelines on how to write well formated and organized code, check out the [Python API Checklist](http://python.apichecklist.com).

README.md

Lines changed: 0 additions & 231 deletions
This file was deleted.

0 commit comments

Comments
 (0)