search

modflowpy / flopy

A Python package to create, run, and post-process MODFLOW-based models.
https://flopy.readthedocs.io
Other
517 stars 313 forks source link

Numpy docstrings now supported in Pycharm 5 #67

Closed langevin-usgs closed 8 years ago

langevin-usgs commented 8 years ago

Pycharm now supports Numpy docstrings, which is what we use in flopy. Instructions for setting it up can be found at: https://www.jetbrains.com/pycharm/help/python-integrated-tools.html

langevin-usgs commented 8 years ago

I just pushed the updated documentation to http://modflowpy.github.io/flopydoc/index.html. For those recurring docstring violators, you may want to compare the documentation with your code to see how it renders.

This was built using all of the docstrings in the development branch as of now.

langevin-usgs commented 8 years ago

For everyone to study: https://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_numpy.html#example-numpy