Skip to content

Commit

Permalink
add note how to use parameter link anchors (CMEM-6044)
Browse files Browse the repository at this point in the history
  • Loading branch information
seebi committed Sep 30, 2024
1 parent 9f7839d commit 8623fb4
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion cmem_plugin_base/dataintegration/description.py
Original file line number Diff line number Diff line change
@@ -224,8 +224,12 @@ class Plugin:
If not set, an identifier will be generated from the module and class name.
:param description: A short (few sentence) description of this plugin.
:param documentation: Documentation for this plugin in Markdown. Note that you
do not need to add a first level heading to the markdown since the
DO NOT need to add a first level heading to the markdown since the
documentation rendering component will add a heading anyway.
In case you want to have a deep link from a parameter description
in the task configuration to this full documentation, you can place a link
anchor in the form of `<a id="parameter_doc_<parameterId>">...</a>` in the
documentation text (the link will be generated automatically).
:param categories: The categories to which this plugin belongs to.
:param parameters: Available plugin parameters.
:param icon: Optional custom plugin icon.

0 comments on commit 8623fb4

Please sign in to comment.