forked from openshmem-org/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
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
Refactor changelog to use new \ChangelogRef
#15
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
One exceptional case involved several references to tables. This item now uses double-commas to separate the ref entries so that `cleveref` will not use range compression.
BryantLam
force-pushed
the
refactor-changelog
branch
from
April 7, 2020 19:39
9fbd2d3
to
e3dd9d1
Compare
jdinan
requested changes
Apr 8, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great -- thanks for these edits! A few minor nitpicks and also wondering whether we want to add back some changelog references that were substituted with references to the deprecation annex.
- Clarify problem with openshmem-org#66 - Change reference for deprecated (now removed) Fortran SHMEM_PUT to cross-reference an OpenSHMEM 1.4 section - Add optional text space in `\ChangelogRef`
BryantLam
force-pushed
the
refactor-changelog
branch
from
April 9, 2020 19:21
9acc9b4
to
11337f1
Compare
jdinan
reviewed
Apr 9, 2020
jdinan
approved these changes
Apr 9, 2020
jdinan
pushed a commit
that referenced
this pull request
Oct 4, 2023
Clarify barrier in shmem_malloc_hints is on SHMEM_TEAM_WORLD
jdinan
pushed a commit
that referenced
this pull request
Oct 4, 2023
Use `{ .. }` sets instead of `[ ... ]` optionals
jdinan
pushed a commit
that referenced
this pull request
Oct 4, 2023
…ackmatter Revert backmatter changes from naveen-rn#3
jdinan
pushed a commit
that referenced
this pull request
Oct 11, 2024
collectives intro: add Scan to team-based list
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR primarily refactors the references in the changelog entries to reduce inconsistencies between entries and to make it easier to later alter its format if desired.
I highly recommend reading the changes in each commit rather than all changes together. This is because eff0264 adds new deprecation-specific labels and then applies them into the changelog — in my opinion this is the only non-trivial change to review and I don't want it to get muddied by the mostly mechanical conversion done in e3dd9d1 which are the bulk of the changes.
Notes:
\ChangelogRef
ends in a%
sigil as a visual reminder to not add a period.\ChangelogRef
is implemented using packagecleveref
. By default, references aresort&compress
. For our purposes, sort is fine. Compress, however, means that many-reference entries are compressed into a range instead; e.g.,See Sections 1, 2, 3, 4 and 5.
is converted intoSee Sections 1 to 5.
. If this behavior is not desired, I can easily change it.,,
because it references tables and tables are spread throughout the document; its references shouldn't be compressed.cleveref
doesn't use the Oxford comma (:cry:). I left it this way, but if we strongly oppose to its non-use, I can change that too.