Improve documentation writing #3302
Open
+18
−21
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
LouisLeNezet
commented
Nov 28, 2024
| @@ -1,4 +1,4 @@ | |||
| # {{ name }}: Contributing Guidelines | |||
| # `{{ name }}`: Contributing Guidelines | |||
There was a problem hiding this comment.
I'm not sure if by adding the '`' the {{name}} will still be changed.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files☔ View full report in Codecov by Sentry. |
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.
During the review of the phaseimpute pipeline a few comments was done on portions of the documentation originating from the template.
Here is the improved documentation.
PR checklist
CHANGELOG.mdis updateddocsis updated