ARM-software / acle

Arm C Language Extensions (ACLE)
Other
85 stars 54 forks source link

Remove comments before <span>s #334

Closed rsandifo-arm closed 1 month ago

rsandifo-arm commented 1 month ago

ACLE had developed a style of prefixing empty s with:

However, this appears to confuse the GitHub renderer when used in bullet points. It was skipping large portions of text after the streaming-intrinsic and vl-dependent anchors, and formatting later text as though it was part of the same bullet point.

Also, I think these large comments make it harder to see the itself. Probably because of this,

16-bit-floating-point-data-processing-operations

had become unmoored from the associated text.

This patch removes the comments (which seems to fix the rendering) and moves 16-bit-floating-point-data-processing-operations to the appropriate place. I checked each anchor manually to make sure that it still worked.


name: Pull request about: Technical issues, document format problems, bugs in scripts or feature proposal.


Thank you for submitting a pull request!

If this PR is about a bugfix:

Please use the bugfix label and make sure to go through the checklist below.

If this PR is about a proposal:

We are looking forward to evaluate your proposal, and if possible to make it part of the Arm C Language Extension (ACLE) specifications.

We would like to encourage you reading through the contribution guidelines, in particular the section on submitting a proposal.

Please use the proposal label.

As for any pull request, please make sure to go through the below checklist.

Checklist: (mark with X those which apply)