fix: Updating markdown files for following one-line format #2373
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
jcagarcia
force-pushed
the
readme-1-line
branch
from
0eebf84 to
73affaa
Compare
jcagarcia
force-pushed
the
readme-1-line
branch
from
73affaa to
cd29396
Compare
dblock
approved these changes
Nov 19, 2023
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.
From a conversation with @dblock in #2371 (comment) I've manually fixed the markdown files for following 1-line format.
I've tried to add the rubocop-md gem, so it can be detected in future PRs. However, there is not a specific rule for this purpose.
An alternative would be add this validation to your https://github.com/ruby-grape/danger project.
What do you think? Do you think is interesting to merge this "fix"?