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

Include cf. (compare) in set of non-line-ending abbreviations #645

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

etomzak
Copy link
Contributor

@etomzak etomzak commented Oct 22, 2024

Without this change, writing

Cf. <<relevant-part-of-spec>>

is formatted to

Cf.
<<relevant-part-of-spec>>

@gmlueck
Copy link
Contributor

gmlueck commented Oct 22, 2024

Do we use "cp." as an abbreviation currently in the SYCL specification? I wonder if we should just write out "compare" instead.

@etomzak
Copy link
Contributor Author

etomzak commented Oct 22, 2024

Consulting the ever-helpful APA, cf. would be more correct than cp. I can make that change in the PR.

As to the use of an abbreviation meaning compare, since the spec already uses i.e., e.g., and etc., for consistency, I think cf. should be available for use (and it shouldn't cause surprising newlines to be inserted by reflow.py when it's used).

I haven't found any use of cp. (or cf.), but I can think of a few places where I'd like to use it.

@gmlueck gmlueck added the editorial Some purely editorial problem label Oct 22, 2024
@etomzak etomzak changed the title Include cp. (compare) in set of non-line-ending abbreviations Include cf. (compare) in set of non-line-ending abbreviations Oct 23, 2024
Copy link
Contributor

@gmlueck gmlueck left a comment

Choose a reason for hiding this comment

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

Please also update the PR description -- it no longer matches this PR.

adoc/scripts/reflow.py Outdated Show resolved Hide resolved
@gmlueck gmlueck self-requested a review October 23, 2024 12:11
@gmlueck
Copy link
Contributor

gmlueck commented Oct 31, 2024

Merging as editorial.

@gmlueck gmlueck merged commit d1bf02b into KhronosGroup:main Oct 31, 2024
2 checks passed
gmlueck added a commit to gmlueck/SYCL-Docs that referenced this pull request Oct 31, 2024
gmlueck added a commit that referenced this pull request Nov 7, 2024
Include cf. (compare) in set of non-line-ending abbreviations

(cherry picked from commit d1bf02b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Some purely editorial problem
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants