|
|
## 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 |