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/revert numpydoc docstrings #744

Merged
merged 2 commits into from Jan 18, 2022
Merged

Conversation

brunnedu
Copy link
Contributor

Summary

Updated docstrings for some statistics and time series generation functions to have docs look more uniform:

  • reverted numpydoc docstring formatting (type hints in docstring)
  • added references where links were previously in the description of the function

Copy link
Contributor

@hrzn hrzn left a comment

Choose a reason for hiding this comment

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

Thanks

@codecov-commenter
Copy link

Codecov Report

Merging #744 (ff3f16f) into master (ddc84a2) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #744      +/-   ##
==========================================
- Coverage   90.80%   90.80%   -0.01%     
==========================================
  Files          67       67              
  Lines        6741     6740       -1     
==========================================
- Hits         6121     6120       -1     
  Misses        620      620              
Impacted Files Coverage Δ
darts/utils/statistics.py 46.70% <ø> (ø)
darts/utils/timeseries_generation.py 95.49% <ø> (ø)
darts/utils/likelihood_models.py 96.04% <0.00%> (-0.01%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ddc84a2...ff3f16f. Read the comment docs.

@brunnedu brunnedu merged commit 334b0d8 into master Jan 18, 2022
@madtoinou madtoinou deleted the fix/revert-numpydoc-docstrings branch July 5, 2023 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants