kakasoo / kakasoo/DeepStrictTypes
[DOCS] Missing `deepStrictAssert` deprecated notation in README
- Dominant language
- TypeScript
- Stars
- 64
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
# 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:
1. Add deprecated notation to `deepStrictAssert`
2. 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:
```bash
npm run build:test && npm run test
```
Contributor guide
Research direction
Start in README.md's Runtime Functions section and compare the deepStrictAssert entry with the @deprecated annotation at src/functions/DeepStrictAssert.ts:13. Add deprecated notation and a migration recommendation for deepStrictPick, then run npm run build:test && npm run test to verify the documentation change does not break the build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100