Skip to content

docs: ✏️ include properties in description of check() #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+1 −1
Open

docs: ✏️ include properties in description of check() #170

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
588423e
docs: :pencil2: include `properties` in description of `check()`
lwjohnst86 Oct 28, 2025
e7c8691
docs: :pencil2: simplify sentence even move
lwjohnst86 Oct 28, 2025
dfeaa5c
docs: :pencil2: small edit
lwjohnst86 Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/design/architecture.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ used throughout the package can be found in the tables below.

| Action | Description |
|----------------------------|--------------------------------------------|
| check | Check that a descriptor conforms to the Data Package standard. |
| check | Check that properties comply with the Data Package standard. |
| explain | Explain issues flagged by the check action in more detail using non-technical language. |
| read | Read various files, such as a Data Package descriptor or a configuration file. |

Expand Down