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.

Sign up for GitHub

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

Jump to bottom

docs(cache): add a typedoc @returns to createHash #361

Merged
merged 1 commit into from
Jun 17, 2022
Merged

docs(cache): add a typedoc @returns to createHash #361

merged 1 commit into from
Jun 17, 2022

Conversation

agilgur5
Copy link
Collaborator

Summary

Add a /** @returns */ typedoc comment to createHash to explicitly mention that it has to be FS-safe

Details

  • per follow-up comments, this has to be FS-safe, so I thought it would be good to explicitly mention that somewhere

@agilgur5
docs(cache): add a typedoc @returns to createHash
46678c5 
- follow-up to my previous commit
  - per comments, this has to be FS-safe, so I thought it would be good to explicitly mention that somewhere
@agilgur5 agilgur5 added scope: docs Documentation could be improved. Or changes that only affect docs kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs scope: cache Related to the cache labels Jun 17, 2022
@ezolenko ezolenko merged commit 9ea15ce into ezolenko:master Jun 17, 2022
@agilgur5 agilgur5 deleted the docs-cache-add-typedoc-returns-createHash branch July 2, 2023 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
kind: internal Changes only affect the internals, and _not_ the public API or external-facing docs scope: cache Related to the cache scope: docs Documentation could be improved. Or changes that only affect docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@agilgur5 @ezolenko