Skip to content

Commit befa599

Browse files
committed
docs: 💄 reformat
1 parent 535a35b commit befa599

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

docs/11_writing_a_profile.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ These instructions assume you are familiar with code development using Python an
6363
checks to write, you can create multiple files - the validator will
6464
collect them all automatically at runtime.
6565

66-
* Note: some profiles split the checks into folders called ``must/``,
66+
.. note::
67+
68+
Some profiles split the checks into folders called ``must/``,
6769
``should/`` and ``may/`` according to the requirement severity. This
6870
is not mandatory - you can also label individual checks/shapes with
6971
``sh:severity`` in the SHACL code instead.
@@ -72,9 +74,8 @@ These instructions assume you are familiar with code development using Python an
7274
an ``ontology.ttl`` file alongside the SHACL files.
7375
This graph is merged into the crate's data graph at validation time,
7476
allowing you to define formal relationships and additional definitions
75-
between profile entities. For example, you can use a specific subclass
76-
in the crate while the profile expects only a more general superclass,
77-
and the ontology clarifies their relationship.
77+
between profile entities (e.g., using ``rdfs:subClassOf``,
78+
``owl:equivalentClass``, etc.).
7879

7980
.. warning::
8081

@@ -103,4 +104,6 @@ When running the validator manually, use ``--profile-identifier`` to select the
103104

104105
The crates in ``tests/data/crates``` can be used as examples for running the validator. For example: ::
105106

106-
rocrate-validator validate --profile-identifier your-profile-name tests/data/crates/invalid/1_wroc_crate/no_mainentity/
107+
rocrate-validator validate \
108+
--profile-identifier your-profile-name \
109+
tests/data/crates/invalid/1_wroc_crate/no_mainentity/

0 commit comments

Comments
 (0)