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

Update module docstring usage #1130

Closed
wants to merge 3 commits into from

Conversation

victorlin
Copy link
Member

Description of proposed changes

See commit messages.

Related issue(s)

N/A

Testing

What steps should be taken to test the changes you've proposed?
If you added or changed behavior in the codebase, did you update the tests, or do you need help with this?

Checklist

  • Add a message in CHANGES.md summarizing the changes in this PR that are end user focused. Keep headers and formatting consistent with the rest of the file.

Instead of letting each command (and subcommands) individually define
the help text, automatically use the first line of module docstrings.
Instructions are somewhat unconventional and scattered, so it may be
unclear how to write a new command without this central explanation.
@codecov
Copy link

codecov bot commented Jan 18, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.02%. Comparing base (be3e404) to head (48b0891).
Report is 1201 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1130      +/-   ##
==========================================
- Coverage   68.03%   68.02%   -0.01%     
==========================================
  Files          62       62              
  Lines        6679     6677       -2     
  Branches     1639     1639              
==========================================
- Hits         4544     4542       -2     
  Misses       1829     1829              
  Partials      306      306              

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

@genehack
Copy link
Contributor

@victorlin this is pretty merge-conflict-y at this point, and never made it beyond draft. Can it be closed out?

@victorlin
Copy link
Member Author

Yeah, closing. I don't remember what I was doing with 1cc6800 + ca4923e, but 48b0891 still seems appropriate so I've created a separate issue for it: #1719

@victorlin victorlin closed this Jan 13, 2025
@victorlin victorlin deleted the victorlin/update-module-docstring-usage branch January 13, 2025 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants