Skip to content

Commit 5e5984f

Browse files
docs: 📝 run explain() code chunk (#264)
# Description We should run this code chunk now that explain works. Needs a quick review. ## Checklist - [x] Ran `just run-all` --------- Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com> Co-authored-by: Luke W. Johnston <lwjohnst@gmail.com>
1 parent 0e78cf0 commit 5e5984f

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

docs/guide/issues.qmd

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,19 @@ here to demonstrate the `explain()` function):
2323

2424
```{python}
2525
import check_datapackage as cdp
26+
from rich import print as rprint
2627
package_properties = cdp.example_package_properties()
2728
del package_properties["resources"]
2829
package_properties
2930
```
3031

3132
You can give the issues found by `check()` to `explain()` to get a more
32-
human-friendly version of the problems:
33+
human-friendly version of the problems (using `rich` for
34+
pretty-printing):
3335

3436
```{python}
35-
#| eval: false
3637
issues = cdp.check(properties=package_properties)
37-
cdp.explain(issues)
38+
rprint(cdp.explain(issues))
3839
```
3940

4041
When setting `error=True` in `check()`, error messages will be generated

0 commit comments

Comments
 (0)