Skip to content

docs: improve API examples organization#219

Open
wujinhh wants to merge 2 commits into
piotrwitek:masterfrom
wujinhh:issue-51-readme-examples
Open

docs: improve API examples organization#219
wujinhh wants to merge 2 commits into
piotrwitek:masterfrom
wujinhh:issue-51-readme-examples

Conversation

@wujinhh

@wujinhh wujinhh commented Jun 4, 2026

Copy link
Copy Markdown

Summary

  • reorganize the API documentation around the README's operator groups
  • add missing built-in utility type examples for Record, Parameters, and ConstructorParameters
  • add missing examples for Partial, Readonly, ReturnType, and InstanceType
  • fix a mismatched ValuesType example label and clarify several sample type names

Verification

  • git diff --check HEAD~1..HEAD

Closes #51

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md Outdated
* [`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)_

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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:

  1. The H2 heading ## Special operators exists 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.
  2. The order of types in the Table of Contents (e.g., listing Deep utilities under ## Object operators before Pick/Omit) does not match the actual order in the body (where Deep utilities are placed near the end, after PromiseType).

We should add DeepNonNullable<T> to the Table of Contents and align the TOC structure/order with the actual body organization.

Comment thread README.md

[⇧ back to top](#table-of-contents)

#### Built-in object modifiers

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

There is an inconsistency in how built-in types are labeled in their section headers:

  • Omit, Record, Parameters, and ConstructorParameters have _(built-in)_ appended to their H3 headers (e.g., ### Omit<T, K> _(built-in)_).
  • Partial, Readonly, ReturnType, and InstanceType do 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.

@wujinhh wujinhh force-pushed the issue-51-readme-examples branch from 9c8cf26 to 40e36b9 Compare June 4, 2026 07:14
@wujinhh wujinhh force-pushed the issue-51-readme-examples branch from 40e36b9 to 5bf6e92 Compare June 4, 2026 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve organization and add missing examples in API documentation

1 participant