Skip to content

Commit 8623fb4

Browse files
committed
add note how to use parameter link anchors (CMEM-6044)
1 parent 9f7839d commit 8623fb4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

cmem_plugin_base/dataintegration/description.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,12 @@ class Plugin:
224224
If not set, an identifier will be generated from the module and class name.
225225
:param description: A short (few sentence) description of this plugin.
226226
:param documentation: Documentation for this plugin in Markdown. Note that you
227-
do not need to add a first level heading to the markdown since the
227+
DO NOT need to add a first level heading to the markdown since the
228228
documentation rendering component will add a heading anyway.
229+
In case you want to have a deep link from a parameter description
230+
in the task configuration to this full documentation, you can place a link
231+
anchor in the form of `<a id="parameter_doc_<parameterId>">...</a>` in the
232+
documentation text (the link will be generated automatically).
229233
:param categories: The categories to which this plugin belongs to.
230234
:param parameters: Available plugin parameters.
231235
:param icon: Optional custom plugin icon.

0 commit comments

Comments
 (0)