Skip to content

Commit

Permalink
Update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
zyzzyxdonta committed Dec 19, 2024
1 parent 679ec34 commit 27bfe15
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/source/_ext/plugin_markup.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,10 @@ def plugin_to_schema_org(plugin: Dict[str, Any]) -> SchemaOrgSoftwarePublication
is expressed as a ``schema:Organization`` using the given author field as the
``name``. The steps targeted by the plugin are expressed using the ``keyword`` field
by transforming them to the keywords ``hermes-step-<STEP>`` where ``<STEP>`` is the
name of the workflow step. If the plugin is marked as a Hermes ``builtin``, this is
expressed using ``schema:isPartOf``.
name of the workflow step. The ``harvested_files`` are also transformed into
keywords by making the text "keyword-friendly" and prepending ``hermes-harvest-``.
If the plugin is marked as a Hermes ``builtin``, this is expressed using
``schema:isPartOf``.
"""
steps = plugin.get("steps", [])
keywords = [f"hermes-step-{step}" for step in steps]
Expand Down

0 comments on commit 27bfe15

Please sign in to comment.