fix: Allow using reference as a verb #117
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The blacklist entry for "reference" triggered a very unsightly workaround in ariel-os/ariel-os#1703.
I think that unless tools have very accessible means for authors of text to acknowledge a concern but decide that it does not apply here, they should err on the side of tolerance: Requiring that authors rephrase "doc: reference this mechanism in that text" causes annoyance, while not rejecting "doc: reference added here and there" is part of language ambiguity for which there are human reviewers in the loop (and not much is lost if a single one slips through eventually).