Skip to content

Commit cc64ecc

Browse files
committed
Update README and tests
Signed-off-by: Jota Martos <[email protected]>
1 parent 8fd8607 commit cc64ecc

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ The following are the tags supported at this very moment:
101101

102102
- For a parameter: `## @param fullKeyPath [modifier?] Description`.
103103
- For a section: `## @section Section Title"`.
104-
- To skip an object and all its children: `## @skip fullKeyPath`.
104+
- To skip an object and all its children: `## @skip fullKeyPath [Description?]`.
105105
- To add a description for an intermediate object (i.e. not final in the YAML tree): `## @extra fullkeyPath Description`.
106106

107107
All the tags as well as the two initial `#` characters for the comments style can be configured in the [configuration file](#configuration-file).

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/test-values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ containerSecurityContext:
249249
## Kubewatch resource requests and limits
250250
## ref: http://kubernetes.io/docs/user-guide/compute-resources/
251251
##
252-
## @skip resources
252+
## @skip resources Optional description
253253
## @disabled-param resources.limits The resources limits for the Kubewatch container
254254
## @disabled-param resources.requests The requested resources for the Kubewatch container
255255
##

0 commit comments

Comments
 (0)