Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/docstring warnings #478

Merged

Conversation

Moritz-Alexander-Kern
Copy link
Member

@Moritz-Alexander-Kern Moritz-Alexander-Kern commented Apr 19, 2022

This PR fixes mostly indentation errors in several doc-strings. The content of the documentation is not affected.

Before:
when building the documentation with:

cd doc && make html

miscellaneous warnings appeared, most of them indentation errors. 51 warnings
See log of make html: Warnings_log_8_make html.txt

With this PR:

  • fixed indentations
    To fix warnings like:
elephant.asset.asset.ASSET.intersection_matrix:28: WARNING: Block quote ends without a blank line; unexpected unindent.
  • added new template for sphinx extension autosummary to document the classes of spike_train_generation.
    This fixes:
WARNING: autosummary: failed to import NonStationaryGammaProcess.process_operational_time.
2022-04-14T17:25:55.5004709Z Possible hints:
2022-04-14T17:25:55.5005191Z * ModuleNotFoundError: No module named 'NonStationaryGammaProcess'
2022-04-14T17:25:55.5005828Z * AttributeError: type object 'NonStationaryGammaProcess' has no attribute 'NonStationaryGammaProcess'
2022-04-14T17:25:55.5006343Z * KeyError: 'NonStationaryGammaProcess'
2022-04-14T17:25:55.5006907Z * AttributeError: type object 'NonStationaryGammaProcess' has no attribute 'process_operational_time'
  • added missing "`" to fix warnings like:
docstring of elephant.conversion.BinnedSpikeTrain:94: WARNING: Inline interpreted text or phrase reference start-string without end-string.
  • fixed citation not found in:
docstring of elephant.spike_train_correlation.cross_correlation_histogram:69: WARNING: citation not found: correlation-Eggermont2010_77

Only 1 Warning (of 51) remains:
DeprecationWarning: pandas_bridge module will be removed in Elephant v0.8.x

See log: Warnings_log_8_make html_after_fix.txt

elephant/spike_train_generation.py Outdated Show resolved Hide resolved
elephant/spike_train_synchrony.py Outdated Show resolved Hide resolved
elephant/gpfa/gpfa.py Show resolved Hide resolved
@Moritz-Alexander-Kern Moritz-Alexander-Kern added this to the v0.12.0 milestone Apr 29, 2022
@coveralls
Copy link
Collaborator

coveralls commented Aug 11, 2022

Coverage Status

Coverage: 87.457% (-0.04%) from 87.493% when pulling 1932770 on INM-6:fix/docstring_warnings into eb9f00e on NeuralEnsemble:master.

@Moritz-Alexander-Kern Moritz-Alexander-Kern added the documentation Indicates a need for improvements or additions to documentation label Aug 11, 2022
Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

Copy link
Member Author

@Moritz-Alexander-Kern Moritz-Alexander-Kern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build wheels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants