-
Notifications
You must be signed in to change notification settings - Fork 86
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
Fix: documentation #143
Fix: documentation #143
Conversation
Fix outdated documentation following breaking change refactor.
* Restore `minute_to_ms` function * Pipe interval option through `minute_to_ms`
Regarding this, I also feel that the v3.0.0 Breaking Changes esction in In the same vein, these lines should be removed from Let me know what you think of these and I'll make the changes accordingly. |
hey there, ideally, we take |
Ok, in that case, shall we update the documentation instead? I've updated the PR accordingly. |
Based on the changes to the example in #138, it seems that the intended use case is still to specify the interval in minutes:guardian_db/lib/guardian/db.ex
Lines 35 to 36 in 5bcc4d5
guardian_db/lib/guardian/db.ex
Lines 44 to 46 in 5bcc4d5
But in the refactoring done in #130, the interval option is passed directly into the worker, without going through the minute-to-millisecond conversion.This PR restores the original behavior, and also updates the outdated example in the README following the refactor.If we don't want to keep this minute-to-ms behavior, the alternative is to update the examples accordingly; in that case, this PR could be the starting point for the discussion.