dbader / dbader/schedule

Confusing API names like every().day() & every().days()

Open
#299 1 comment 2 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
12.3k
Forks
999
PR merge metrics
No merged PRs in 30d

Description

Thanks for the API. It is really simple and easy-to-use.

We were using `schedule` module to trigger and run our periodic jobs. However, I was confused with the naming convention that `every().day()` will only once in that day whereas `every().days()` will run for all days. **In general, anything after `every()` is repetitive and human intuitive**. So, it's really confusing in the first place while using this method. Same follows for other dimensions like [(hour, hours), (minute, minutes), (week, weeks), (month, months)]

There was a lack of documentation explaining the clear difference between them. It would be **really awesome** if we change the names or providing better documentation. I'd **love to provide help** in this if needed.

Thanks again for the wonderful API.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.