Updated Readthedocs documentation in line with current practices. #2048
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2048 +/- ##
==========================================
- Coverage 98.39% 98.39% -0.01%
==========================================
Files 124 133 +9
Lines 12212 13060 +848
==========================================
+ Hits 12016 12850 +834
- Misses 196 210 +14 ☔ View full report in Codecov by Sentry. |
brhooper
reviewed
Nov 8, 2024
| 1. Issues should be assigned to a main reviewer. Adding multiple | ||
| reviewers to the pull request is encouraged to help share expertise. | ||
| Please ask for help assigning reviewers if you need it. | ||
| 1. All reviewers are encouraged to add comments to the pull request. |
There was a problem hiding this comment.
The numbering in this section needs updating.
doc/source/Running-at-your-site.rst
Outdated
Comment on lines
164
to
165
| bin/improver-tests unit # runs unit tests | ||
| bin/improver-tests --help # Prints out the help information |
There was a problem hiding this comment.
These lines are also on 133-134. I think they can be removed here to avoid duplication.
doc/source/Code-Style-Guide.rst
Outdated
Comment on lines
540
to
541
| As mentioned above, it is important to ensure that no other functionality | ||
| than passing inputs into the plugin is done within the CLI layer. |
There was a problem hiding this comment.
Suggested change
| As mentioned above, it is important to ensure that no other functionality | |
| than passing inputs into the plugin is done within the CLI layer. | |
| As mentioned above, it is important to ensure that no functionality | |
| other than calling the plugin exists within the CLI layer. |
doc/source/Code-Style-Guide.rst
Outdated
Comment on lines
542
to
543
| So any checks on the data or requirements of inputs should be done in | ||
| the plugin itself. |
There was a problem hiding this comment.
Suggested change
| So any checks on the data or requirements of inputs should be done in | |
| the plugin itself. | |
| Any checks on the data or input requirements should be done in the plugin itself. |
doc/source/Code-Style-Guide.rst
Outdated
Comment on lines
40
to
42
| * Avoid putting any functionality within the CLI at all other than | ||
| passing in arguments to the plugin, all functionality should be | ||
| done within the plugin layer itself. |
There was a problem hiding this comment.
Suggested change
| * Avoid putting any functionality within the CLI at all other than | |
| passing in arguments to the plugin, all functionality should be | |
| done within the plugin layer itself. | |
| * Avoid adding functionality to CLIs beyond calling the relevant plugin, all other functionality should be added to the plugin itself. |
| @@ -80,6 +75,7 @@ As a Reviewer: | |||
|
|
|||
| * Does the code do what is supposed to? | |||
| * Are errors handled appropriately? | |||
| * Is the code written to be run efficiently? | |||
There was a problem hiding this comment.
Suggested change
| * Is the code written to be run efficiently? | |
| * Is the code efficient with respect to processing time and memory requirements? |
There was a problem hiding this comment.
There is also a typo under 5.d which could be corrected here:
Does the code do what is supposed to? -> Does the code do what it is supposed to?
There was a problem hiding this comment.
Thanks, I've changed both.
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.
Addresses https://github.com/metoppv/mo-blue-team/issues/795
This PR updates the best practices sections on the Readthedocs site in line with our current ways of working.
To build the webpages locally attempt the following: