Docs: Clarify line breaks in object-curly-newline (refs #14024)

eslint · Mar 12, 2021 · a7022c6 · a7022c6
1 parent 672ee29
commit a7022c6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/rules/object-curly-newline.md b/docs/rules/object-curly-newline.md
@@ -4,14 +4,14 @@ A number of style guides require or disallow line breaks inside of object braces
 
 ## Rule Details
 
-This rule enforces consistent line breaks after opening and before closing braces of object literals or destructuring assignments.
+More precisely, the rule requires or disallows a line break between { and its following token, and between } and its preceding token of object literals or destructuring assignments.
 
 ## Options
 
 This rule has either a string option:
 
-* `"always"` requires line breaks inside braces
-* `"never"` disallows line breaks inside braces
+* `"always"` requires line breaks after opening and before closing braces
+* `"never"` disallows line breaks after opening and before closing braces
 
 Or an object option:
 

diff --git a/lib/rules/object-curly-newline.js b/lib/rules/object-curly-newline.js
@@ -134,7 +134,7 @@ module.exports = {
         type: "layout",
 
         docs: {
-            description: "enforce consistent line breaks inside braces",
+            description: "enforce consistent line breaks after opening and before closing braces",
             category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/object-curly-newline"