Merge pull request #390 from ernilambar/382-add-make-pot-examples

swissspidy · web-flow · commit b7225568c5b1 · 2024-02-29T11:45:50.000+01:00
diff --git a/README.md b/README.md
@@ -134,12 +134,14 @@ if the source directory is detected as either a plugin or theme.
 
 **EXAMPLES**
 
-    # Create a POT file for the WordPress plugin/theme in the current directory
+    # Create a POT file for the WordPress plugin/theme in the current directory.
     $ wp i18n make-pot . languages/my-plugin.pot
 
     # Create a POT file for the continents and cities list in WordPress core.
-    $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php"
-    --ignore-domain
+    $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php" --ignore-domain
+
+    # Create a POT file for the WordPress theme in the current directory with custom headers.
+    $ wp i18n make-pot . languages/my-theme.pot --headers='{"Report-Msgid-Bugs-To":"https://github.com/theme-author/my-theme/","POT-Creation-Date":""}'
 
 
 
diff --git a/src/MakePotCommand.php b/src/MakePotCommand.php
@@ -273,12 +273,14 @@ class MakePotCommand extends WP_CLI_Command {
 	 *
 	 * ## EXAMPLES
 	 *
-	 *     # Create a POT file for the WordPress plugin/theme in the current directory
+	 *     # Create a POT file for the WordPress plugin/theme in the current directory.
 	 *     $ wp i18n make-pot . languages/my-plugin.pot
 	 *
 	 *     # Create a POT file for the continents and cities list in WordPress core.
-	 *     $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php"
-	 *     --ignore-domain
+	 *     $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php" --ignore-domain
+	 *
+	 *     # Create a POT file for the WordPress theme in the current directory with custom headers.
+	 *     $ wp i18n make-pot . languages/my-theme.pot --headers='{"Report-Msgid-Bugs-To":"https://github.com/theme-author/my-theme/","POT-Creation-Date":""}'
 	 *
 	 * @when before_wp_load
 	 *

Original file line number	Diff line number	Diff line change
`@@ -273,12 +273,14 @@ class MakePotCommand extends WP_CLI_Command {`
`273`	`273`	`*`
`274`	`274`	`* ## EXAMPLES`
`275`	`275`	`*`
`276`		`- * # Create a POT file for the WordPress plugin/theme in the current directory`
	`276`	`+ * # Create a POT file for the WordPress plugin/theme in the current directory.`
`277`	`277`	`* $ wp i18n make-pot . languages/my-plugin.pot`
`278`	`278`	`*`
`279`	`279`	`* # Create a POT file for the continents and cities list in WordPress core.`
`280`		`- * $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php"`
`281`		`- * --ignore-domain`
	`280`	`+ * $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php" --ignore-domain`
	`281`	`+ *`
	`282`	`+ * # Create a POT file for the WordPress theme in the current directory with custom headers.`
	`283`	`+ * $ wp i18n make-pot . languages/my-theme.pot --headers='{"Report-Msgid-Bugs-To":"https://github.com/theme-author/my-theme/","POT-Creation-Date":""}'`
`282`	`284`	`*`
`283`	`285`	`* @when before_wp_load`
`284`	`286`	`*`