docs: improve API examples organization#219
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to document several built-in utility types (such as Record, Parameters, and ConstructorParameters), adds subheadings to better organize the document, and provides usage examples for existing types. The review feedback highlights structural mismatches and ordering inconsistencies between the Table of Contents and the document body, as well as inconsistent labeling of built-in types in their section headers.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| * [`Omit<T, K>`](#omitt-k) _(built-in)_ | ||
| * [`Pick<T, K>`](#pickt-k-built-in) _(built-in)_ | ||
| * [`Omit<T, K>`](#omitt-k-built-in) _(built-in)_ | ||
| * [`Record<K, T>`](#recordk-t-built-in) _(built-in)_ |
There was a problem hiding this comment.
The Table of Contents is missing DeepNonNullable<T>, which is documented in the body under #### Deep object utilities (around line 958). Additionally, there is a structural mismatch between the Table of Contents and the actual document body:
- The H2 heading
## Special operatorsexists in the Table of Contents (line 135) but is completely absent in the body, where its types are grouped under H4 subheadings under## Object operators. - The order of types in the Table of Contents (e.g., listing Deep utilities under
## Object operatorsbeforePick/Omit) does not match the actual order in the body (where Deep utilities are placed near the end, afterPromiseType).
We should add DeepNonNullable<T> to the Table of Contents and align the TOC structure/order with the actual body organization.
|
|
||
| [⇧ back to top](#table-of-contents) | ||
|
|
||
| #### Built-in object modifiers |
There was a problem hiding this comment.
There is an inconsistency in how built-in types are labeled in their section headers:
Omit,Record,Parameters, andConstructorParametershave_(built-in)_appended to their H3 headers (e.g.,###Omit<T, K>_(built-in)_).Partial,Readonly,ReturnType, andInstanceTypedo not have_(built-in)_in their H3 headers (e.g.,###Partial``).
To maintain consistency across all built-in utility types, we should either append _(built-in)_ to all of their headers (and update their Table of Contents anchors accordingly) or keep the headers clean and only use the _(built-in)_ label in the Table of Contents.
9c8cf26 to
40e36b9
Compare
40e36b9 to
5bf6e92
Compare
Summary
Verification
Closes #51