Skip to content

Commit 9310bda

Browse files
committed
docs: 📝 add docstring examples to example properties
So they are shown in reference docs.
1 parent c328343 commit 9310bda

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/check_datapackage/examples.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ def example_resource_properties() -> dict[str, Any]:
77
88
Returns:
99
A set of example resource properties.
10+
11+
Examples:
12+
```{python}
13+
import check_datapackage as cdp
14+
15+
cdp.example_resource_properties()
16+
```
1017
"""
1118
return {
1219
"name": "woolly-dormice-2015",
@@ -20,6 +27,13 @@ def example_package_properties() -> dict[str, Any]:
2027
2128
Returns:
2229
A set of example package properties.
30+
31+
Examples:
32+
```{python}
33+
import check_datapackage as cdp
34+
35+
cdp.example_package_properties()
36+
```
2337
"""
2438
return {
2539
"name": "woolly-dormice",

0 commit comments

Comments
 (0)