Make phpcs happy

WordPress · Jun 2, 2017 · 5c7d641 · 5c7d641
1 parent 278a8af
commit 5c7d641
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 0 deletions.
diff --git a/lib/blocks.php b/lib/blocks.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Functions related to editor blocks for the Gutenberg editor plugin.
+ *
+ * @package gutenberg
+ */
 
 if ( ! defined( 'ABSPATH' ) ) {
 	die( 'Silence is golden.' );

diff --git a/lib/client-assets.php b/lib/client-assets.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Functions to register client-side assets (scripts and stylesheets) for the
+ * Gutenberg editor plugin.
+ *
+ * @package gutenberg
+ */
 
 if ( ! defined( 'ABSPATH' ) ) {
 	die( 'Silence is golden.' );

diff --git a/lib/i18n.php b/lib/i18n.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Internationalization-related functions for the Gutenberg editor plugin.
+ *
+ * @package gutenberg
+ */
 
 if ( ! defined( 'ABSPATH' ) ) {
 	die( 'Silence is golden.' );

diff --git a/lib/register.php b/lib/register.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Initialization and wp-admin integration for the Gutenberg editor plugin.
+ *
+ * @package gutenberg
+ */
 
 if ( ! defined( 'ABSPATH' ) ) {
 	die( 'Silence is golden.' );

diff --git a/phpcs.ruleset.xml b/phpcs.ruleset.xml
@@ -5,6 +5,11 @@
 	<rule ref="WordPress-Core" />
 	<rule ref="WordPress-Docs" />
 
+	<!-- index.php already has a file comment, I promise -->
+	<rule ref="Squiz.Commenting.FileComment.Missing">
+		<exclude-pattern>index.php</exclude-pattern>
+	</rule>
+
 	<!-- Do not require docblocks for unit tests -->
 	<rule ref="Squiz.Commenting.FunctionComment.Missing">
 		<exclude-pattern>phpunit/*</exclude-pattern>