agronholm / apscheduler

Task scheduling library for Python
MIT License
6.18k stars 704 forks source link

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

Closed peterschutt closed 3 months ago

peterschutt commented 4 months ago

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):

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 commented 4 months ago

Coverage Status

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

agronholm commented 3 months ago

Thanks!