Skip to content

Commit a8336b8

Browse files
committed
DOC-3190: Clarify author identification process in comments callback documentation.
1 parent 52fbd99 commit a8336b8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

modules/ROOT/pages/comments-callback-mode.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ All options accept functions incorporating `+done+` and `+fail+` callbacks as pa
1515
* The `+fail+` callback takes either a string or a JavaScript Error type.
1616
* The `+done+` callback takes an argument specific to each function.
1717

18-
Most functions (create, reply, and edit) require an `+id+` identifying the *current author*.
18+
Most functions (create, reply, and edit) require an +id+ identifying the current author. This can be provided directly within the callbacks or dynamically via the `+tinycomments_fetch_author_info+` option.
1919

2020
[NOTE]
21-
**Current author**: The {pluginname} plugin does not know the name of the current user. Determining the current user and storing the comment related to that user is required to be configured by the integrator.
21+
**Current author**: By default, the **Comments** plugin does not know the name of the current user. To display the correct author information when creating a new conversation, integrators can now use the `+tinycomments_fetch_author_info+` option to supply author details dynamically through a callback.
2222

2323
During the initial editor load, the {pluginname} uses `+tinycomments_fetch+` callback to retrieve the existing conversations in the document. If not configured, the {pluginname} will fallback to `+tinycomments_lookup+`.
2424

0 commit comments

Comments
 (0)