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

WRO-12876: Change @extends value format in jsdoc #3103

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

sjro
Copy link
Contributor

@sjro sjro commented Oct 27, 2022

Checklist

  • I have read and understand the contribution guide
  • A CHANGELOG entry is included
  • At least one test case is included for this feature or bug fix
  • Documentation was added or is not needed
  • This is an API breaking change

Issue Resolved / Feature Added

@extends tag link is broken.

Resolution

In gatsby-transformer-documentation plugin source code (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-transformer-documentationjs/src/gatsby-node.js), only the string that comes after dot is explicitly stored as name.
So, change the jsdoc format for @extends

ex)
@extends ui/BodyText.BodyTextBase
=> @extends ui/BodyText#BodyTextBase

Additional Considerations

Links

WRO- 12868, WRO-12876

Comments

Enact-DCO-1.0-Signed-off-by: SJ RO ([email protected])

@codecov
Copy link

codecov bot commented Oct 27, 2022

Codecov Report

Base: 81.21% // Head: 81.21% // No change to project coverage 👍

Coverage data is based on head (4f48783) compared to base (0f928b6).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3103   +/-   ##
========================================
  Coverage    81.21%   81.21%           
========================================
  Files          152      152           
  Lines         7101     7101           
  Branches      1850     1850           
========================================
  Hits          5767     5767           
  Misses        1051     1051           
  Partials       283      283           
Impacted Files Coverage Δ
packages/ui/BodyText/BodyText.js 100.00% <ø> (ø)
packages/ui/Button/Button.js 91.30% <ø> (ø)
packages/ui/FloatingLayer/FloatingLayer.js 81.94% <ø> (ø)
packages/ui/Group/Group.js 100.00% <ø> (ø)
packages/ui/Heading/Heading.js 100.00% <ø> (ø)
packages/ui/Icon/Icon.js 87.80% <ø> (ø)
packages/ui/IconButton/IconButton.js 100.00% <ø> (ø)
packages/ui/Image/Image.js 100.00% <ø> (ø)
packages/ui/ImageItem/ImageItem.js 100.00% <ø> (ø)
packages/ui/Item/Item.js 100.00% <ø> (ø)
... and 15 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

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.

1 participant