Add JSDocs #4598
Add JSDocs #4598
Conversation
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit b6ab35a:
|
| * Whether the current state value is a subset of the given parent state value. | ||
| * @param testValue | ||
| * Whether the current state value is a subset of the given partial state value. | ||
| * @param partialStateValue |
There was a problem hiding this comment.
partial sounds like literally a partial of the state value but for a state value like { a: 'b' } we can also test against 'a'
There was a problem hiding this comment.
Yeah, was just trying to figure out something less ambiguous than testValue, which doesn't suggest a state value
Co-authored-by: Mateusz Burzyński <[email protected]>
Co-authored-by: Mateusz Burzyński <[email protected]>
Co-authored-by: Mateusz Burzyński <[email protected]>
|
One thing I'd like to add here is - it would be super cool to provide simple example of usage for most important functions, such as |
The Just some gaps that need to be filled |
packages/core/src/typegenTypes.ts
Outdated
| @@ -10,12 +10,26 @@ import { | |||
| IndexByProp | |||
| } from './types.ts'; | |||
|
|
|||
| /** | |||
| * @internal | |||
There was a problem hiding this comment.
Marking those as deprecated might blow up somewhere since they will disappear from the generated declaration files.
There was a problem hiding this comment.
I don't think it disappears from the generated declaration files: https://www.typescriptlang.org/play#example/jsdoc-deprecated
There was a problem hiding this comment.
Sorry, I meant "marking those as internal"
|
Let's merge this sooner than later. We don't need a long-lived umbrella branch for this - those JSDoc improvements can land incrementally. |
Co-authored-by: Mateusz Burzyński <[email protected]>
No description provided.