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

Remove comments before <span>s #334

Merged
merged 1 commit into from
Jul 23, 2024

Conversation

rsandifo-arm
Copy link
Contributor

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)

  • If an issue reporting the bug exists, I have mentioned it in the
    PR (do not bother creating the issue if all you want to do is
    fixing the bug yourself).
  • I have added/updated the SPDX-FileCopyrightText lines on top
    of any file I have edited. Format is SPDX-FileCopyrightText: Copyright {year} {entity or name} <{contact informations}>
    (Please update existing copyright lines if applicable. You can
    specify year ranges with hyphen , as in 2017-2019, and use
    commas to separate gaps, as in 2018-2020, 2022).
  • I have updated the Copyright section of the sources of the
    specification I have edited (this will show up in the text
    rendered in the PDF and other output format supported). The
    format is the same described in the previous item.
  • I have run the CI scripts (if applicable, as they might be
    tricky to set up on non-*nix machines). The sequence can be
    found in the contribution
    guidelines
    . Don't
    worry if you cannot run these scripts on your machine, your
    patch will be automatically checked in the Actions of the pull
    request.
  • I have added an item that describes the changes I have
    introduced in this PR in the section Changes for next
    release
    of the section Change Control/Document history
    of the document. Create Changes for next release if it does
    not exist. Notice that changes that are not modifying the
    content and rendering of the specifications (both HTML and PDF)
    do not need to be listed.
  • When modifying content and/or its rendering, I have checked the
    correctness of the result in the PDF output (please refer to the
    instructions on how to build the PDFs
    locally
    ).
  • The variable draftversion is set to true in the YAML header
    of the sources of the specifications I have modified.
  • Please DO NOT add my GitHub profile to the list of contributors
    in the README page of the project.

ACLE had developed a style of prefixing empty <span>s with:

<!-- Do not remove the following `span`, it is needed to create an
anchor that can be referred via an internal hyperlink to the paragraph
following it. -->

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 <span>
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.
Copy link
Contributor

@sdesmalen-arm sdesmalen-arm left a comment

Choose a reason for hiding this comment

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

This change looks fine to me, thanks for fixing this!

@rsandifo-arm rsandifo-arm merged commit 437954a into ARM-software:main Jul 23, 2024
4 checks passed
Copy link
Contributor

@sallyarmneale sallyarmneale left a comment

Choose a reason for hiding this comment

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

LGTM

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.

3 participants