Skip to content

Commit e5d6471

Browse files
Replace Recommonmark by MyST (#188)
Fix leftover tags in admonitions
1 parent c28a1af commit e5d6471

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/source/contribute.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,18 +44,18 @@ All wrappers and OSP-core are part of a common directory structure:
4444
The changes should be clearly explained in the issue/Pull Request.
4545
```{warning}
4646
If the issue is a critical software bug detected in the stable release, a
47-
:code:`hotfix branch` should be created from the :code:`master/main` branch
47+
`hotfix branch` should be created from the `master/main` branch
4848
instead.
4949
5050
After committing to such branch, a new Pull/Merge request (targeting
51-
:code:`dev`) should be created. If the fix is correct, the project owner
52-
will merge the PR to :code:`dev`, additionally merge the
53-
:code:`hotfix branch` to :code:`master/main`, and then delete the
54-
:code:`hotfix branch`.
51+
`dev`) should be created. If the fix is correct, the project owner
52+
will merge the PR to `dev`, additionally merge the
53+
`hotfix branch` to `master/main`, and then delete the
54+
`hotfix branch`.
5555
```
5656
- Once the features for a release have been reached, `dev` will be merged to
5757
`master/main`. Every new commit in the `master/main` branch generally corresponds
58-
to a new release, which is labeled with a
58+
to a new release, which is labelled with a
5959
[git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) matching its
6060
version number. An exception to this rule may apply, for example when several
6161
critical hotfixes are applied in a row, as it would then be better to just to

docs/source/detailed_design.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -468,7 +468,7 @@ cuds_obj = some_namespace.OntologyClass()
468468
and then they are yielded like a generator
469469

470470
```{hint}
471-
There is also an :code:`is_a` method for checking oclass inheritance.
471+
There is also an `is_a` method for checking oclass inheritance.
472472
```
473473

474474
```{note}
@@ -626,10 +626,10 @@ This will define which methods have to be implemented and `_engine` as the acces
626626
trigger an action on the backend (`run` and `commit`, respectively).
627627

628628
```{note}
629-
You might have noticed that the semantic layer defines :code:`remove` in the API,
630-
but in the session and registry we use :code:`delete`. The different between them
631-
is conceptual: :code:`remove` is interpreted as detachment i.e. removal of edges,
632-
while :code:`delete` implies the erasure of the note itself.
629+
You might have noticed that the semantic layer defines `remove` in the API,
630+
but in the session and registry we use `delete`. The different between them
631+
is conceptual: `remove` is interpreted as detachment i.e. removal of edges,
632+
while `delete` implies the erasure of the node itself.
633633
```
634634

635635
#### Buffers

docs/source/general_architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ For that, a 3 layer schema is used:
114114
backend -[hidden]-> spe
115115
```
116116

117-
- The *Semantic layer* are the classes generated from the ontology and follow the CUDS API.
117+
- The *Semantic layer* are the classes generated from the ontology with the CUDS API.
118118
- The *Interoperability layer* maps the changes in the semantic layer to calls in the syntactic layer.
119119
- The *Syntactic layer* provides access to the backend.
120120

0 commit comments

Comments
 (0)