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 example docstring, dont expand constants in docstrings #4880

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Conversation

jackgerrits
Copy link
Member

Closes #4464

@jackgerrits jackgerrits requested a review from Copilot January 2, 2025 17:54

Choose a reason for hiding this comment

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

@codecov-commenter
Copy link

codecov-commenter commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.21%. Comparing base (a1d782d) to head (4d608a0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4880   +/-   ##
=======================================
  Coverage   68.21%   68.21%           
=======================================
  Files         158      158           
  Lines        9960     9960           
=======================================
  Hits         6794     6794           
  Misses       3166     3166           
Flag Coverage Δ
unittests 68.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@ekzhu ekzhu merged commit bac6dc5 into main Jan 3, 2025
56 checks passed
@ekzhu ekzhu deleted the docstring branch January 3, 2025 02:37
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.

Add example of good doc sting to CONTRIBUTING.md
3 participants