[DOC] Clarify some intended functionality in docs #127
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
manics
reviewed
Jun 9, 2025
docs/use.md
Outdated
|
|
||
| ## Include Pull Request reviewers and commenters in your changelog | ||
|
|
||
| By default, GitHub Activity will include any _reviewer_ of a pull request in the item for that PR. This looks like the following: |
Contributor
There was a problem hiding this comment.
Is there meant to be an example or a cross-ref here?
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
Co-authored-by: Simon Li <orpheus+devel@gmail.com>
choldgraf
commented
Jun 9, 2025
Member
Author
|
@manics fixed up the suggested edits, thanks! |
manics
approved these changes
Jun 9, 2025
Member
Author
|
Thanks for the review! |
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 documents more of the intended functionality of the tool, rather than relying on users needing to install it first and then run
github-activity --helpto discover it.