-
Notifications
You must be signed in to change notification settings - Fork 63k
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
This content:
docs/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md
Line 53 in ed48eab
When you edit a comment, note the location that the content was removed from and optionally, the reason for removing it. |
... feels more like instructions for how a specific project should operate, as opposed to the world at large. If it's the world at large, then it should be integrated into the tooling.
This should really have its own anchor, for redacting
information:
docs/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md
Line 59 in ed48eab
Comment authors and anyone with write access to a repository can also delete sensitive information from a comment's edit history. For more information, see "[Tracking changes in a comment](/communities/moderating-comments-and-conversations/tracking-changes-in-a-comment)." |
docs/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md
Lines 64 to 65 in ed48eab
3. In the comment window, delete the content you'd like to remove, then type `[REDACTED]` to replace it. | |
 |
The content should also include a note that it's merely a suggestion.
docs/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md
Line 80 in ed48eab
If a comment contains some constructive content that adds to the conversation in the issue or pull request, you can edit the comment instead. |
It's a bit late in the chronology to make this suggestion. I'd suggest it precede the information about deleting a comment (i.e. before Deleting a comment is your last resort as a moderator.
). But, I want to be careful to not be too prescriptive (the current content suffers from this...).
There should be an anchor for the steps:
docs/content/communities/moderating-comments-and-conversations/managing-disruptive-comments.md
Line 88 in ed48eab
1. Navigate to the comment you'd like to delete. |
Additional information
Fwiw, while this information is interesting, it is definitely not complete.
I found this page because I was researching a behavior I noticed today which does not appear to be documented.