From 4e4dc1150cfac2463668c9e326d619202ba06ad6 Mon Sep 17 00:00:00 2001 From: Jon McPartland Date: Fri, 1 Mar 2024 12:10:24 +0000 Subject: [PATCH 1/5] Docs: add documentation for Squiz.WhiteSpace.MemberVarSpacing --- .../WhiteSpace/MemberVarSpacingStandard.xml | 142 ++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml diff --git a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml new file mode 100644 index 0000000000..00cfbf67a9 --- /dev/null +++ b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml @@ -0,0 +1,142 @@ + + + + + + + + + protected $var1 = 'value'; +} + +interface MyInterface { + + public $var1; +} + +trait MyTrait { + + public $var1 = 'value'; +} + ]]> + + + + protected $var1 = 'value'; +} + + +interface MyInterface { + public $var1; +} + + +trait MyTrait { + + + public $var1 = 'value'; +} + ]]> + + + + + + + + + + protected $var2 = 'value2'; +} + +interface MyInterface { + + public $var1; + + public $var2; +} + +trait MyTrait { + + public $var1 = 'value'; + + public $var2 = 'value2'; +} + ]]> + + + + protected $var2 = 'value2'; +} + + +interface MyInterface { + + public $var1; + public $var2; +} + + +trait MyTrait { + + public $var1 = 'value'; + + + public $var2 = 'value2'; +} + ]]> + + + + + + + + + public $actions = array(); +} + ]]> + + + + + public $actions = array(); +} + ]]> + + + From aaddb379909183b6e9350b04c8ddef13b9454021 Mon Sep 17 00:00:00 2001 From: Jon McPartland Date: Fri, 1 Mar 2024 17:06:17 +0000 Subject: [PATCH 2/5] Docs: improve code examples and descriptions for Squiz.WhiteSpace.MemberVarSpacing - Remove invalid structures - Clarify and improve wording (member var => property) - Remove excessive code examples - Clarify and improve wording (comment => DocBlock) --- .../WhiteSpace/MemberVarSpacingStandard.xml | 76 +++---------------- 1 file changed, 11 insertions(+), 65 deletions(-) diff --git a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml index 00cfbf67a9..cb307b3ba8 100644 --- a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml +++ b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml @@ -1,73 +1,36 @@ - + protected $var1 = 'value'; -} - -interface MyInterface { - - public $var1; -} - -trait MyTrait { - - public $var1 = 'value'; } ]]> - + protected $var1 = 'value'; -} - - -interface MyInterface { - public $var1; -} - - -trait MyTrait { - - - public $var1 = 'value'; } ]]> - + - - protected $var2 = 'value2'; -} - -interface MyInterface { - - public $var1; - - public $var2; -} - trait MyTrait { public $var1 = 'value'; @@ -76,23 +39,8 @@ trait MyTrait { } ]]> - + - protected $var2 = 'value2'; -} - - -interface MyInterface { - - public $var1; - public $var2; -} - - trait MyTrait { public $var1 = 'value'; @@ -105,14 +53,13 @@ trait MyTrait { - + - + Date: Mon, 4 Mar 2024 10:22:22 +0000 Subject: [PATCH 3/5] Docs: add more specific wording to Squiz.WhiteSpace.MemberVarSpacing --- .../Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml index cb307b3ba8..4ae142f313 100644 --- a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml +++ b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml @@ -1,7 +1,7 @@ @@ -25,7 +25,7 @@ class MyClass From 421ffea94c803ca12e21b3a5666ca51056ba732d Mon Sep 17 00:00:00 2001 From: Jon McPartland Date: Mon, 4 Mar 2024 10:23:51 +0000 Subject: [PATCH 4/5] Docs: update code example for Squiz.WhiteSpace.MemberVarSpacing Show both too much and too little whitespace in one example --- .../Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml index 4ae142f313..6cbd58a831 100644 --- a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml +++ b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml @@ -35,7 +35,9 @@ trait MyTrait { public $var1 = 'value'; - public $var2 = 'value2'; + public $var2 = 'value2'; + + public $var3 = 'value3'; } ]]> @@ -46,7 +48,8 @@ trait MyTrait { public $var1 = 'value'; - public $var2 = 'value2'; + public $var2 = 'value2'; + public $var3 = 'value3'; } ]]> From a2486034f5154bfe4b13236f12223b6314ddbfbd Mon Sep 17 00:00:00 2001 From: Jon McPartland Date: Mon, 4 Mar 2024 10:25:05 +0000 Subject: [PATCH 5/5] Docs: adjust code example for Squiz.WhiteSpace.MemberVarSpacing - Add anonymous class assignment and missing semi-colons --- .../Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml index 6cbd58a831..a551af8a97 100644 --- a/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml +++ b/src/Standards/Squiz/Docs/WhiteSpace/MemberVarSpacingStandard.xml @@ -62,7 +62,7 @@ trait MyTrait { public $actions = array(); -} +}; ]]> public $actions = array(); -} +}; ]]>