Skip to content

[DOCS] Missing deepStrictAssert deprecated notation in README #53

@kakasoo

Description

@kakasoo

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:

npm run build:test && npm run test

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions