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

Convert all docstrings to numpy-style format #608

Merged
merged 20 commits into from
Oct 24, 2023
Merged

Convert all docstrings to numpy-style format #608

merged 20 commits into from
Oct 24, 2023

Conversation

jobovy
Copy link
Owner

@jobovy jobovy commented Oct 20, 2023

With the help of GitHub Copilot using the following prompt

Replace just this docstring with a numpy style docstring; Make entries in the HISTORY section into a bullet-pointed Notes section with bullet points with exactly the same text and formatting (including starting with year-month-day) as each line in the HISTORY section; make sure to keep indentation the same as before and only change the docstring. Replace, don't add. Don’t add types. Leave the function signature alone.

@codecov
Copy link

codecov bot commented Oct 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2c77613) 99.92% compared to head (44e0980) 99.92%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #608   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files         198      198           
  Lines       29173    29175    +2     
=======================================
+ Hits        29150    29152    +2     
  Misses         23       23           
Files Coverage Δ
galpy/actionAngle/actionAngle.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleAdiabatic.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleAdiabaticGrid.py 99.35% <ø> (ø)
galpy/actionAngle/actionAngleAdiabatic_c.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleHarmonic.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleHarmonicInverse.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleInverse.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleIsochrone.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleIsochroneApprox.py 100.00% <ø> (ø)
galpy/actionAngle/actionAngleIsochroneInverse.py 100.00% <ø> (ø)
... and 103 more

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

@jobovy jobovy merged commit c15fb01 into main Oct 24, 2023
104 checks passed
@jobovy jobovy deleted the numpy-docstrings branch October 24, 2023 16:21
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.

1 participant