As requested in [IMPORTANT] Stop creating issues here, use the Shopify Community forum instead · Issue #2521 · Shopify/ui-extensions · GitHub, I am re-raising this issue.
Please find below the details of Documentation for position contains incorrectly parsed docblocks · Issue #2135 · Shopify/ui-extensions · GitHub
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:
- Visit the docs for View component at:
View - Click on the “Position” prop to view its documentation.
- 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 *.
