Skip to content

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

Merged
ezolenko merged 1 commit into
ezolenko:masterfrom
agilgur5:docs-cache-add-typedoc-returns-createHash
Jun 17, 2022
Merged

docs(cache): add a typedoc @returns to createHash#361
ezolenko merged 1 commit into
ezolenko:masterfrom
agilgur5:docs-cache-add-typedoc-returns-createHash

Conversation

@agilgur5

Copy link
Copy Markdown
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

- 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

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

Development

Successfully merging this pull request may close these issues.

2 participants