Documentation
Description
src/functions/DeepStrictAssert.ts has a @deprecated JSDoc annotation, but the README.md Runtime Functions section does not show a deprecated notation. Users may unknowingly use the deprecated function in new code.
Current State
- Code (
src/functions/DeepStrictAssert.ts:13): @deprecated Use {@link deepStrictPick} instead.
- README:
deepStrictAssert is described as a regular function without any deprecation notice
Fix
In the README's Runtime Functions table or section:
- Add deprecated notation to
deepStrictAssert
- Add migration guide recommending
deepStrictPick usage
Test Requirements
Since this is a documentation change, code tests are not required, but verify that the build does not break:
npm run build:test && npm run test
Documentation
Description
src/functions/DeepStrictAssert.tshas a@deprecatedJSDoc annotation, but the README.md Runtime Functions section does not show a deprecated notation. Users may unknowingly use the deprecated function in new code.Current State
src/functions/DeepStrictAssert.ts:13):@deprecated Use {@link deepStrictPick} instead.deepStrictAssertis described as a regular function without any deprecation noticeFix
In the README's Runtime Functions table or section:
deepStrictAssertdeepStrictPickusageTest Requirements
Since this is a documentation change, code tests are not required, but verify that the build does not break: