DOCSTRING: moved from top to class (netcdf) #319
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
As far I understand, the docstrings at the top of files are not included in the documentation.
For instance, the netcdf.py (in scipy.io) contains Notes and examples which are not in the doc
(I checked there: http://docs.scipy.org/doc/scipy/reference/tutorial/io.html?highlight=netcdf#module-scipy.io.netcdf and http://docs.scipy.org/doc/scipy/reference/generated/scipy.io.netcdf.netcdf_file.html#scipy.io.netcdf.netcdf_file)
Since notes and examples document the usage of netcdf_file, I moved these sections in the docstring of this class.
Please, correct me if I'm wrong.