Skip to content
GitLab
Explore
Sign in
Register
Admin message
Gitlab has been updated. More info
here
.
limbra
limbra
Wiki
DocumentingPythonCode
DocumentingPythonCode
· Changes
Page history
legac created page: DocumentingPythonCode
authored
Jul 14, 2015
by
LE GAC Renaud
Hide whitespace changes
Inline
Side-by-side
DocumentingPythonCode.markdown
0 → 100644
View page @
f318900c
## Documenting the python code
*form the [sphinx.ext.napoleon](http://sphinx-doc.org/ext/napoleon.html) extension*
*
Use the
[
Google Python Style Guide
](
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
)
```
Args:
path (str): The path of the file to wrap
field_storage (FileStorage): The :class:`FileStorage` instance to wrap
temporary (bool): Whether or not to delete the file when the File
instance is destructed
Returns:
BufferedFileStorage: A buffered writable file descriptor
```
*
[
Example of Google style python docstring
](
http://sphinx-doc.org/ext/example_google.html#example-google
)
\ No newline at end of file