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.

Sign up for GitHub

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

Jump to bottom

added package level doc strings. #441

Merged
merged 2 commits into from
Jan 31, 2024
Merged

added package level doc strings. #441

merged 2 commits into from
Jan 31, 2024

Conversation

TimothyStiles
Copy link
Collaborator

@TimothyStiles TimothyStiles commented Jan 31, 2024 •
edited
Loading

Changes in this PR

Two packages are making doc strings.

Why are you making these changes?

For better documentation.

Are any changes breaking? (IMPORTANT)

No

Pre-merge checklist

All of these must be satisfied before this PR is considered
ready for merging. Mergeable PRs will be prioritized for review.

  • New packages/exported functions have docstrings.
  • New/changed functionality is thoroughly tested.
  • New/changed functionality has a function giving an example of its usage in the associated test file. See primers/primers_test.go for what this might look like.
  • Changes are documented in CHANGELOG.md in the [Unreleased] section.
  • All code is properly formatted and linted.
  • The PR template is filled out.

@TimothyStiles TimothyStiles merged commit f18c391 into main Jan 31, 2024
10 checks passed
@TimothyStiles TimothyStiles deleted the package-strings branch January 31, 2024 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@TimothyStiles