UG: Document new dynamic get_keyword_tags method
@@ -1812,11 +1812,14 @@ Framework and dynamic libraries. It does not matter for Robot
Framework how these libraries are actually implemented (for example,
how calls to the `run_keyword` method are mapped to a correct
keyword implementation), and many different approaches are
-possible. However, if you use Java, you may want to examine
-`JavalibCore <https://github.com/robotframework/JavalibCore>`__
-before implementing your own system. This collection of
-reusable tools supports several ways of creating keywords, and it is
+possible. However, if you use Java, you may want to examine the
+JavaLibCore__ project before implementing your own system. This collection
+of reusable tools supports several ways of creating keywords, and it is
likely that it already has a mechanism that suites your needs.
+Python users may also find the similar PythonLibCore__ project useful.
+
+__ https://github.com/robotframework/JavalibCore
+__ https://github.com/robotframework/PythonLibCore
.. _`Getting dynamic keyword names`:
@@ -1978,14 +1981,32 @@ accepting all arguments. This automatic argument spec is either
__ `Named argument syntax with dynamic libraries`_
__ `Free keyword arguments with dynamic libraries`_
+Getting keyword tags
+~~~~~~~~~~~~~~~~~~~~
+
+Starting from Robot Framework 3.0.2, dynamic libraries can report `keyword
+tags`_ by using the `get_keyword_tags` method (alias `getKeywordTags`). It
+gets a keyword name as an argument, and should return corresponding tags
+as a list of strings.
+
+Alternatively it is possible to specify tags on the last row of the
+documentation returned by the `get_keyword_documentation` method discussed
+below. This requires starting the last row with `Tags:` and listing tags
+after it like `Tags: first tag, second, third`. This approach works also
+with Robot Framework versions prior to 3.0.2.
+
+.. tip:: The `get_keyword_tags` method is guaranteed to be called before
+ the `get_keyword_documentation` method. This makes it easy to
+ embed tags into the documentation only if the `get_keyword_tags`
+ method is not called.
+
Getting keyword documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The final special method that dynamic libraries can implement is
-`get_keyword_documentation` (alias
-`getKeywordDocumentation`). It takes a keyword name as an
-argument and, as the method name implies, returns its documentation as
-a string.
+If dynamic libraries want to provide keyword documentation, they can implement
+the `get_keyword_documentation` method (alias `getKeywordDocumentation`). It
+takes a keyword name as an argument and, as the method name implies, returns
+its documentation as a string.
The returned documentation is used similarly as the keyword
documentation string with static libraries implemented with
@@ -1994,14 +2015,6 @@ library documentation generated by Libdoc_. Additionally,
the first line of the documentation (until the first `\n`) is
shown in test logs.
-Getting keyword tags
-~~~~~~~~~~~~~~~~~~~~
-
-Dynamic libraries do not have any other way for defining `keyword tags`_
-than by specifying them on the last row of the documentation with `Tags:`
-prefix. Separate `get_keyword_tags` method can be added to the dynamic API
-later if there is a need.
-
Getting general library documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
