[llvm][docs] Improve usage note on stacked PRs #138949
Open
Conversation
This file contains hidden or 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
paschalis-mpeis
requested review from
banach-space,
mstorsjo,
boomanaiden154 and
joker-eph
|
Just realized I forgot to update the note references in #138126. Any thoughts? |
boomanaiden154
approved these changes
May 7, 2025
joker-eph
approved these changes
May 8, 2025
| When not using user branches, GitHub will not display proper diffs for | ||
| subsequent PRs in a stack. Instead, it will show a combined diff that | ||
| includes all commits from earlier PRs. | ||
| When using the dependency notes approach, GitHub will not display proper |
There was a problem hiding this comment.
I would prefer some clearer/unambiguous way to refer to the approaches above. To me:
not using user branchesis clearer thanthe dependency notes approach.
Primarily because we have a dedicated paragraph on user branches. But that might simply be my bias. If you like dependency notes then I suggest:
dependency notes->"dependency note"(use quotes to signal that it's some "custom" thing defined in this document + use singular as we are only asking for one note in the 2nd paragraph above).
Hope this makes sense :)
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.
No description provided.