Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve visualization for complex types #608

Merged
merged 2 commits into from
Mar 15, 2022
Merged

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Mar 9, 2022

  • Surround type parameters with <>
Diff (T)

Old
grafik

New
grafik

  • Add extends/type to typeParameters
Diff (T)

Old
grafik

New
grafik

  • Improve complex type representation
Diff (options / example)

Old
grafik

New
grafik

  • Add support for method option params
Diff (opts.compare)

Old
grafik

New
grafik

@ST-DDT ST-DDT added the c: docs Improvements or additions to documentation label Mar 9, 2022
@ST-DDT ST-DDT requested a review from a team as a code owner March 9, 2022 19:05
@ST-DDT ST-DDT self-assigned this Mar 9, 2022
@codecov
Copy link

codecov bot commented Mar 9, 2022

Codecov Report

Merging #608 (220c294) into main (c933d24) will not change coverage.
The diff coverage is 100.00%.

❗ Current head 220c294 differs from pull request most recent head d815710. Consider uploading reports for the commit d815710 to get more accurate results

@@           Coverage Diff           @@
##             main     #608   +/-   ##
=======================================
  Coverage   99.33%   99.33%           
=======================================
  Files        1920     1920           
  Lines      176444   176444           
  Branches      898      898           
=======================================
  Hits       175265   175265           
  Misses       1123     1123           
  Partials       56       56           
Impacted Files Coverage Δ
src/unique.ts 100.00% <100.00%> (ø)

@Shinigami92 Shinigami92 requested a review from a team March 9, 2022 20:51
@ST-DDT ST-DDT linked an issue Mar 11, 2022 that may be closed by this pull request
@Shinigami92 Shinigami92 enabled auto-merge (squash) March 15, 2022 15:10
@Shinigami92 Shinigami92 merged commit f038937 into main Mar 15, 2022
@ST-DDT ST-DDT deleted the docs/better-types branch March 15, 2022 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: improve generic type representation in the docs
3 participants