modifierOrder option documentation clarification (#1691)

nicklockwood · Jun 18, 2024 · c2de327 · c2de327
1 parent dd989a4
commit c2de327
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Rules.md b/Rules.md
@@ -1259,6 +1259,9 @@ Option | Description
 + private convenience init()
 ```
 
+**NOTE:** If the option value is empty, the following order will be used by default:
+`override,private,fileprivate,internal,package,public,open,private(set),fileprivate(set),internal(set),package(set),public(set),open(set),final,dynamic,optional,required,convenience,indirect,isolated,nonisolated,nonisolated(unsafe),lazy,weak,unowned,static,class,borrowing,consuming,mutating,nonmutating,prefix,infix,postfix`
+
 </details>
 <br/>
 

diff --git a/Sources/Examples.swift b/Sources/Examples.swift
@@ -937,6 +937,9 @@ private struct Examples {
     - convenience private init()
     + private convenience init()
     ```
+
+    **NOTE:** If the option value is empty, the following order will be used by default:
+    `\(_FormatRules.defaultModifierOrder.flatMap { $0 }.joined(separator: ","))`
     """
 
     let strongifiedSelf = """