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

Add docstrings to main functions #83

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft

Conversation

vinferrer
Copy link
Member

@vinferrer vinferrer commented Apr 16, 2022

Closes #74 .

Changes proposed in this pull request:

  • Add docstring to the different functions

@vinferrer vinferrer added documentation Improvements or additions to documentation priority: low labels Apr 16, 2022
@vinferrer
Copy link
Member Author

vinferrer commented Apr 16, 2022

Eyy @eurunuela , This doesn't have great priority, however could you add the docstring for the stability lars functions

@codecov
Copy link

codecov bot commented Apr 16, 2022

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.70%. Comparing base (7e3cc16) to head (c96763d).
Report is 131 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #83   +/-   ##
=======================================
  Coverage   92.70%   92.70%           
=======================================
  Files          15       15           
  Lines         795      795           
=======================================
  Hits          737      737           
  Misses         58       58           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority: low
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc string missing in functions
1 participant