Shopify / ui-extensions

MIT License
248 stars 35 forks source link

Documentation for position contains incorrectly parsed docblocks #2135

Open edhgoose opened 1 week ago

edhgoose commented 1 week ago

Please list the package(s) involved in the issue, and include the version you are using

Describe the bug

Position documentation contains unclear wording.

Steps to reproduce the behavior:

  1. Visit the docs for View component at: https://shopify.dev/docs/api/checkout-ui-extensions/2024-04/components/structure/view
  2. Click on the "Position" prop to view its documentation.
  3. Observe the docs are unclear due to presence of *'s which look like docblocks to me:
{ /** * Changes how the View is positioned. For setting the position, only properties * that set the offset on a different axis can be set simultaneously. This means * that these combinations are not allowed: * * ``` * { blockStart, blockEnd } * ``` * * ``` * { inlineStart, inlineEnd } * ``` * * @defaultValue 'relative' */ type?: 
PositionType
; } & 
PositionCoordinates

Expected behavior

Normal sentences, without *.

Screenshots

CleanShot 2024-06-23 at 18 08 56@2x

Additional context