Docs for <Repeater/> tag (#346)

* Add docs for <Repeater/> using virtual tag file

* fix jsdoc with nested function params

* update description for Repeater tag

* updating to add keywords to repeater tag

Co-authored-by: smoreface <[email protected]>
Co-authored-by: Max Tkachenko <[email protected]>

Author: 3 people

src/regions/BrushRegion.js

@@ -348,7 +348,8 @@ const Model = types
        */
 
       /**
-       * @param {{ fast?: boolean }} options `fast` is for saving only touches, without RLE
+       * @param {object} options
+       * @param {boolean} [options.fast] saving only touches, without RLE
        * @return {BrushRegionResult}
        */
       serialize(options) {

src/tags/visual/Repeater.js

@@ -0,0 +1,22 @@
+// this is just a virtual tag, expanded directly in Tree.tsx during config parsing
+
+/**
+ * Repeater Tag for annotating multiple data objects in a dynamic range with the same semantics. You can loop through data items in a python-like for cycle in the labeling process.
+ * It repeats tags inside it for every item in a given data array from your dataset. Supports all tags except Labels.
+ * @example
+ * <Repeater on="$utterances" indexFlag="{{idx}}">
+ *   <Text name="user_{{idx}}" value="$utterances[{{idx}}].text"/>
+ *   <Header value="Utterance Review"/>
+ *   <Choices name="utterance_action_{{idx}}" showInline="true" toName="user_{{idx}}">
+ *     <Choice value="No Action"/>
+ *     <Choice value="Training"/>
+ *     <Choice value="New Intent"/>
+ *   </Choices>
+ * </Repeater>
+ * @name Repeater
+ * @meta_title Repeater Tag to duplicate annotation settings
+ * @meta_description Customize Label Studio with the Repeater tag to repeat similar data blocks to accelerate labeling for machine learning and data science projects.
+ * @param {string} on                  - Data field object with array with similar data
+ * @param {string} [indexFlag={{idx}}] - Placeholder for array index in params of underlying tags
+ */
+export const Repeater = () => {};