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

Merged

Conversation

Moritz-Alexander-Kern
Copy link
Member

@Moritz-Alexander-Kern Moritz-Alexander-Kern commented Mar 23, 2023

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.

With this PR:

  • fixed indentations

Only 4 Warnings remain:

elephant/doc/reference/spade.rst:13: WARNING: duplicate label "Stella, 2019" for keys "citations-Stella2019_104022" and "spade-Stella2019_104022"
elephant/doc/reference/spike_train_generation.rst:43: WARNING: duplicate label "Staude, 2010" for keys "cubic-Staude2010_327" and "generation-Staude2010_327"
elephant/doc/reference/spike_train_surrogates.rst:12: WARNING: duplicate label "Louis, 2010" for keys "surrogates-Louis2010_127" and "surrogates-Louis2010_359"
elephant/doc/reference/unitary_event_analysis.rst:20: WARNING: duplicate label "Gr{\"u}n, 2002" for keys "unitary_event_analysis-Gruen02_43" and "unitary_event_analysis-Gruen02_81"

See log: Warnings_log_8_make html_after_fix.txt

Moritz-Alexander-Kern and others added 30 commits April 14, 2022 19:09
# Conflicts:
#	elephant/spade.py
@Moritz-Alexander-Kern Moritz-Alexander-Kern changed the title Fix/docstring warnings Fix/docstring warnings 2 Mar 23, 2023
@coveralls
Copy link
Collaborator

coveralls commented Mar 23, 2023

Coverage Status

Coverage: 87.996%. Remained the same when pulling d6971c5 on INM-6:fix/docstring_warnings into a8aab43 on NeuralEnsemble:master.

@Moritz-Alexander-Kern Moritz-Alexander-Kern added build html This will trigger the upload of the docs html files as artifact in github actions documentation Indicates a need for improvements or additions to documentation and removed build html This will trigger the upload of the docs html files as artifact in github actions labels Mar 23, 2023
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

@Moritz-Alexander-Kern Moritz-Alexander-Kern added this to the v0.13.0 milestone Jul 11, 2023
@Moritz-Alexander-Kern Moritz-Alexander-Kern merged commit 8736123 into NeuralEnsemble:master Jul 12, 2023
@Moritz-Alexander-Kern Moritz-Alexander-Kern deleted the fix/docstring_warnings branch July 21, 2023 12:29
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.

[Bug] Docs fail to build with provided dependencies and raise weird issues
2 participants