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

feat(addon-doc): add type reference handler for improve documentation #6086

Merged
merged 1 commit into from
Dec 1, 2023

Conversation

splincode
Copy link
Member

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Refactoring
  • Build or CI related changes
  • Tests related changes
  • Documentation content changes

What is the new behaviour?

image image

Copy link

lumberjack-bot bot commented Nov 24, 2023

Pull request was closed ✔️

All saved screenshots (for current PR) were deleted 🗑️

Copy link
Contributor

github-actions bot commented Nov 24, 2023

Visit the preview URL for this PR (updated for commit eb659d5):

https://taiga-ui--pr6086-splincode-feat-type-6othcr6a.web.app

(expires Sat, 02 Dec 2023 20:09:39 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 4b5ece1e114386f6a105425ef799091475b249eb

Copy link

bundlemon bot commented Nov 24, 2023

BundleMon

Files updated (2)
Status Path Size Limits
demo/browser/main.(hash).js
376.04KB (+1.19KB +0.32%) +10%
demo/browser/runtime.(hash).js
41.14KB (+45B +0.11%) +10%
Unchanged files (3)
Status Path Size Limits
demo/browser/vendor.(hash).js
198.18KB +10%
demo/browser/polyfills.(hash).js
11.22KB +10%
demo/browser/styles.(hash).css
1.22KB +10%

Total files change +1.24KB +0.2%

Groups updated (1)
Status Path Size Limits
demo/browser/*..js
2.28MB (+1.51KB +0.06%) -

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

Copy link

codecov bot commented Nov 24, 2023

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (1dcbee6) 71.90% compared to head (eb659d5) 70.42%.
Report is 3 commits behind head on main.

Files Patch % Lines
...ponents/documentation/pipes/type-reference.pipe.ts 40.00% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6086      +/-   ##
==========================================
- Coverage   71.90%   70.42%   -1.49%     
==========================================
  Files        1462     1103     -359     
  Lines       15995    13104    -2891     
  Branches     2274     1848     -426     
==========================================
- Hits        11501     9228    -2273     
+ Misses       4122     3566     -556     
+ Partials      372      310      -62     
Flag Coverage Δ
addon-charts 71.10% <ø> (ø)
addon-doc 60.08% <81.81%> (+0.64%) ⬆️
addon-mobile 60.49% <ø> (ø)
addon-table 60.37% <ø> (ø)
addon-tablebars 90.90% <ø> (ø)
cdk ∅ <ø> (∅)
core 77.89% <ø> (ø)
kit 70.19% <ø> (ø)
summary 70.42% <81.81%> (-1.49%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@splincode splincode changed the title feat(addon-copy): add type reference handler for improve documentation feat(addon-doc): add type reference handler for improve documentation Nov 27, 2023
@splincode splincode force-pushed the splincode/feat/type-reference branch from d40b3d1 to af06c2c Compare November 27, 2023 15:29
@splincode splincode force-pushed the splincode/feat/type-reference branch from af06c2c to 6281d98 Compare November 27, 2023 15:41
@splincode splincode force-pushed the splincode/feat/type-reference branch 2 times, most recently from a365288 to 94b75c3 Compare November 28, 2023 21:40
Copy link
Collaborator

@waterplea waterplea left a comment

Choose a reason for hiding this comment

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

In Button API:
image

I also wonder if we can somehow improve the auto link to the type. Maybe it can search for type XXX / interface XXX?

@splincode splincode force-pushed the splincode/feat/type-reference branch from 94b75c3 to 8991da4 Compare November 29, 2023 09:50
@splincode splincode requested a review from waterplea November 29, 2023 09:51
@splincode splincode force-pushed the splincode/feat/type-reference branch from 8991da4 to 9c7eb20 Compare November 30, 2023 13:33
@splincode
Copy link
Member Author

@waterplea hello, please review me

Copy link
Collaborator

@waterplea waterplea left a comment

Choose a reason for hiding this comment

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

This is great! A few small issues I have managed to find:
image

CustomEvent should probably be handled the same way ReadonlyArray is (see Svg component)

@splincode splincode force-pushed the splincode/feat/type-reference branch from 9c7eb20 to eb659d5 Compare December 1, 2023 20:05
@splincode
Copy link
Member Author

@waterplea fixed

@splincode splincode merged commit e139770 into main Dec 1, 2023
33 of 34 checks passed
@splincode splincode deleted the splincode/feat/type-reference branch December 1, 2023 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

3 participants