Skip to content

Commit ac2adce

Browse files
authored
docs: ✏️ fix broken and missing URLs (#212)
# Description Updated links to documentation for CustomCheck and RequiredCheck. Needs a quick review. ## Checklist - [x] Formatted Markdown - [ ] Ran `just run-all`
1 parent 15dedbd commit ac2adce

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/guide/config.qmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,11 @@ license_check = cdp.CustomCheck(
134134
)
135135
```
136136

137-
For more details on what each parameter means, see the `CustomCheck`
138-
documentation. Specific to this example, the `type` is setting the
139-
identifier of the check to `only-mit` and the `jsonpath` is indicating
140-
to only check the `name` property of each license in the `licenses`
141-
property of the Data Package.
137+
For more details on what each parameter means, see the
138+
[`CustomCheck`](/docs/reference/CustomCheck.qmd) documentation. Specific
139+
to this example, the `type` is setting the identifier of the check to
140+
`only-mit` and the `jsonpath` is indicating to only check the `name`
141+
property of each license in the `licenses` property of the Data Package.
142142

143143
To register your custom checks with the `check()` function, you add them
144144
to the `Config` object passed to the function:
@@ -166,7 +166,7 @@ description_required = cdp.RequiredCheck(
166166
)
167167
```
168168

169-
See the [`RequiredCheck`](/docs/reference/required_check.qmd)
169+
See the [`RequiredCheck`](/docs/reference/RequiredCheck.qmd)
170170
documentation for more details on its parameters.
171171

172172
To apply this `RequiredCheck`, it should be added to the `Config` object

0 commit comments

Comments
 (0)