From b334700866c24d8d6041ce1ccb6f4c4544bbeefa Mon Sep 17 00:00:00 2001
From: Artur Arseniev <artur.catch@hotmail.it>
Date: Thu, 15 Jun 2023 12:33:49 +0400
Subject: [PATCH] Update setRule JSDoc

---
 src/css_composer/index.ts | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/src/css_composer/index.ts b/src/css_composer/index.ts
index 25f0b2293..e00929790 100644
--- a/src/css_composer/index.ts
+++ b/src/css_composer/index.ts
@@ -268,12 +268,12 @@ export default class CssComposer extends ItemManagerModule<CssComposerConfig & {
   /**
    * Add/update the CssRule.
    * @param {String} selectors Selector string, eg. `.myclass`
-   * @param {Object} style  Style properties and values
-   * @param {Object} [opts={}]  Additional properties
-   * @param {String} [opts.atRuleType='']  At-rule type, eg. `media`
-   * @param {String} [opts.atRuleParams='']  At-rule parameters, eg. `(min-width: 500px)`
+   * @param {Object} style  Style properties and values. If the rule exists, styles will be replaced unless `addStyles` option is used.
+   * @param {Object} [opts={}]  Additional properties.
+   * @param {String} [opts.atRuleType='']  At-rule type, eg. `media`.
+   * @param {String} [opts.atRuleParams='']  At-rule parameters, eg. `(min-width: 500px)`.
    * @param {Boolean} [opts.addStyles=false] If the rule exists already, merge passed styles instead of replacing them.
-   * @returns {[CssRule]} The new/updated CssRule
+   * @returns {[CssRule]} The new/updated CssRule.
    * @example
    * // Simple class-based rule
    * const rule = css.setRule('.class1.class2', { color: 'red' });
@@ -286,7 +286,12 @@ export default class CssComposer extends ItemManagerModule<CssComposerConfig & {
    *  atRuleType: 'media',
    *  atRuleParams: '(min-width: 500px)',
    * });
-   * // output: @media (min-width: 500px) { .class1:hover { color: red } }
+   * // output: `@media (min-width: 500px) { .class1:hover { color: red } }`
+   *
+   * // Update styles of existent rule
+   * css.setRule('.class1', { color: 'red', background: 'red' });
+   * css.setRule('.class1', { color: 'blue' }, { addStyles: true });
+   * // output: .class1 { color: blue; background: red }
    */
   setRule(selectors: any, style: CssRuleProperties['style'] = {}, opts: SetRuleOptions = {}) {
     const { atRuleType, atRuleParams } = opts;