Added more comprehensive docstrings to values, using helm-docs tool #346
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
…sing helm-docs tool
|
Note: on github currently the README looks a little squished and I'm not sure the best way of fixing this... https://github.com/DiamondLightSource/blueapi/tree/helm-docs/helm/blueapi |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #346 +/- ##
=======================================
Coverage 87.14% 87.14%
=======================================
Files 42 42
Lines 1642 1642
=======================================
Hits 1431 1431
Misses 211 211 ☔ 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.
Added extra descriptions in the helm documentation for the values.yaml file. Auto generated a README in the helm repository containing this information in a table.
Perhaps we should setup a CI job to do this, as part of this PR? I think this should also be done for the nexus-filewriting-service.