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

Correct some drift b/w docstring and datastructure fields. #919

Merged
merged 3 commits into from
Jun 8, 2024

Conversation

peterschutt
Copy link
Contributor

Changes

Correct documented parameters for some datastructures.

Checklist

If this is a user-facing code change, like a bugfix or a new feature, please ensure that
you've fulfilled the following conditions (where applicable):

  • You've added tests (in tests/) added which would fail without your patch
  • You've updated the documentation (in docs/, in case of behavior changes or new
    features)
  • You've added a new changelog entry (in docs/versionhistory.rst).

If this is a trivial change, like a typo fix or a code reformatting, then you can ignore
these instructions.

Updating the changelog

If there are no entries after the last release, use **UNRELEASED** as the version.
If, say, your patch fixes issue #999, the entry should look like this:

* Fix big bad boo-boo in the async scheduler (#999 <https://github.com/agronholm/apscheduler/issues/999>_; PR by Yourname)

If there's no issue linked, just link to your pull request instead by updating the
changelog after you've created the PR.

If possible, use your real name in the changelog entry. If not, use your GitHub
username.

@coveralls
Copy link

coveralls commented May 27, 2024

Coverage Status

coverage: 92.84% (-0.09%) from 92.928%
when pulling a8d0867 on peterschutt:doc-strings
into 0cfca07 on agronholm:master.

Copy link
Owner

@agronholm agronholm left a comment

Choose a reason for hiding this comment

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

LGTM!

@agronholm agronholm merged commit c988087 into agronholm:master Jun 8, 2024
13 checks passed
@agronholm
Copy link
Owner

Thanks!

@peterschutt peterschutt deleted the doc-strings branch June 10, 2024 01:42
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.

3 participants