docs: add "how it works" section #57
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ilveroluca
reviewed
Dec 12, 2024
docs/4_how_it_works.rst
Outdated
| will prompt the user to select a profile from the list of candidate | ||
| profiles; | ||
|
|
||
| - **Non-Interactive Mode:** the system will use all candidate profiles |
simleo
requested changes
Dec 13, 2024
docs/4_how_it_works.rst
Outdated
| triggered the error. Note that multiple rules may have the same error message, | ||
| which can result in output with apparently duplicate errors. | ||
|
|
||
| Naturally, `rocrate-validator` is limited to validating conformance to RO-Crate |
There was a problem hiding this comment.
I'd remove the starting "Naturally, "
docs/4_how_it_works.rst
Outdated
| Validation profiles can be related by inheritance -- i.e., where one validation | ||
| profile extends another one. Normally this happens with profiles that validate | ||
| conformance to RO-Crate profiles that themselves extend a base profile, such as | ||
| Workflow Testing RO-Crate, which extends Workflow RO-Crate. |
There was a problem hiding this comment.
I find this remark confusing. I would simply say:
"Validation profiles can be related by inheritance -- i.e., where one validation profile extends another one. For instance, Workflow Testing RO-Crate extends Workflow RO-Crate".
docs/4_how_it_works.rst
Outdated
|
|
||
| * **Automatic Profile Matching** (default): | ||
| By default, `rocrate-validator` will attempt to select the correct validation | ||
| profiles for the input RO-Crate based on the `conformsTo` property. |
There was a problem hiding this comment.
Suggested change
| profiles for the input RO-Crate based on the `conformsTo` property. | |
| profiles for the input RO-Crate based on the `conformsTo` property of the Root Data Entity. |
docs/4_how_it_works.rst
Outdated
| - If a precise match is found for the `conformsTo` property, that profile is selected | ||
| for validation. | ||
|
|
||
| - If no precise match is found, the system will: |
There was a problem hiding this comment.
Suggested change
| - If no precise match is found, the system will: | |
| - If no precise match is found: |
docs/4_how_it_works.rst
Outdated
| will prompt the user to select a profile from the list of candidate | ||
| profiles; | ||
|
|
||
| - **Non-Interactive Mode:** the system will use all candidate profiles |
There was a problem hiding this comment.
Suggested change
| - **Non-Interactive Mode:** the system will use all candidate profiles | |
| - in **Non-Interactive Mode:** the system will use all candidate profiles |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
a live preview is available here