Skip to content

Conversation

@denis-rossati
Copy link
Member

@denis-rossati denis-rossati commented Aug 29, 2023

Summary

At the moment, consumers of the lib don't have a clue what unit of time to use in cache parameters, is it minutes, hours, seconds?

This PR add a jsdoc to help them when they're coding.

Related Issues

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@github-actions
Copy link

👋 @denis-rossati
Thanks for your contribution!
The approval and merge process is almost fully automated 🧙
Here's how it works:

  1. You open a new pull request
  2. Automated tests check the code
  3. Maintainers review the code
  4. Once approved, the PR is ready to merge.

👉 Omit the extended description
Please remove the commit body before merging the pull request.
Instead, include the pull request number in the title to provide the full context
about the change.

☝️ Lastly, the title for the commit will come from the pull request title. So please provide a descriptive title that summarizes the changes in 50 characters or less using the imperative mood.
Happy coding! 🎉

@denis-rossati denis-rossati requested a review from Fryuni August 29, 2023 18:44
@marcospassos marcospassos merged commit 54ef02f into master Sep 1, 2023
@marcospassos marcospassos deleted the document-time-units-parameter branch September 1, 2023 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance Housekeeping

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document time units of parameters

6 participants