Skip to content

Commit c973b3d

Browse files
committed
Better document the orcidio_support option.
The inline documentation for the `orcidio_support` option is the only real user-facing documentation we currently have, so it should give a better idea of what the option actually does.
1 parent 81fa244 commit c973b3d

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

src/incatools/odk/model.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1144,7 +1144,14 @@ class OntologyProject(JsonSchemaMixin):
11441144
"""Generates a diff with the previous release."""
11451145

11461146
orcidio_support: bool = False
1147-
"""Extracts ORCIDIO individuals representing the contributors to the ontology."""
1147+
"""Enables the automatic production of an ORCIDIO import module.
1148+
1149+
If enabled, this option will cause the build pipeline to (1) scan
1150+
the ontology for references to ORCID identifiers in all IRI-valued
1151+
annotations, and (2) create a orcidio_import.owl import module
1152+
containing all ORCIDIO individuals corresponding to the referenced
1153+
ORCID identifiers.
1154+
"""
11481155

11491156
robot: RobotOptionsGroup = field(default_factory=lambda: RobotOptionsGroup())
11501157
"""ROBOT-related options."""

0 commit comments

Comments
 (0)