Welcome to the filehandlers contributing guidelines! Please follow what is listed here to help keep the project simple, easy to maintain, and complete.
When writing code, please follow PEP8 , the style guide written for any Python. One exception for this is our line length - PEP8 says 79 characters is the limit, but we have decided to extend that to a maximum of 100 characters per line. Also, wherever possible, please add Docstrings.
We mainly use normal reStructuredText Docstrings for filehandlers.
However, for elements that have more then one field - for example if
a function has the potential to throw multiple exceptions -
we use Google  and/or
NumPy  styled Docstrings.
These are later converted by the Sphinx extension
Please add Docstrings to functions, classes, modules (at the top), exceptions
If you add a class that is not covered by the documentation currently (e.x. you create
a method or class that is not in a method/class that has the
autodoc method), you will need to add a field so autodoc knows the include the Docstring(s).
To do this, navigate to the API reference page and add this underneath all the other
,.. autoclass:: ClassName ,:members: ,:special-members: __init__
,.. autofunction:: function_name
,.. autoexception:: ExceptionName
- Make sure to remove the commas, they prevent autodoc from trying to add a method here on this page!
- You do not need to add module Docstrings to the API reference page.
Building the package¶
python setup.py sdist bdist_wheel.
If you are on Linux/macOS, change
The build shouldn’t be long. When it is complete, you can find the
.whl in the
|||Python Enhancement Proposal #8|
|||Google Docstring Guide|
|||NumPy Docstring Guide|