More terminology improvements within the plugin (#54)

Signed-off-by: Miles Davis <milesddavis@users.noreply.github.com>
Co-authored-by: Miles Davis <milesddavis@users.noreply.github.com>

inc/assets/namespace.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Replaces assets normally hosted on WordPress.org or the WordPress.com CDN with FAIR hosted copies.
+ * Configures FAIR hosted assets throughout WordPress.
  *
  * @package FAIR
  */
@@ -31,18 +31,18 @@ function get_emoji_base_url() : string {
 }
 
 /**
- * Replace the CDN domain for regular Twemoji images.
+ * Configure the base URL for regular emoji images.
  *
- * @return string Replaced URL.
+ * @return string The base URL.
  */
 function replace_emoji_url() {
     return get_emoji_base_url() . '72x72/';
 }
 
 /**
- * Replace the CDN domain for regular Twemoji images.
+ * Configure the base URL for SVG emoji images.
  *
- * @return string Replaced URL.
+ * @return string The base URL.
  */
 function replace_emoji_svg_url() {
     return get_emoji_base_url() . 'svg/';

inc/credits/namespace.php

@@ -1,7 +1,6 @@
 <?php
 /**
- * Prevents calls to the Credits API.
- * Prevents calls to Gravatar.com.
+ * Configures the Credits API to fetch credits from local files.
  *
  * @package FAIR
  */
@@ -21,7 +20,9 @@ function bootstrap() {
 }
 
 /**
- * Replace versions 1.0 and 1.1 of the Credits API with local file copies.
+ * Respond to a Credits API request with a response from a local file.
+ *
+ * Supports Credits API versions 1.0 and 1.1.
  *
  * @param false|array|WP_Error $response Filtered response.
  * @param array $parsed_args The request's arguments.
@@ -115,7 +116,7 @@ function get_credits( string $major_version ) {
 }
 
 /**
- * Get a fake response.
+ * Mock an HTTP response for the Credits API with the local credits data.
  *
  * @param string $body The response's body.
  * @return array The response.

inc/dashboard-widgets/namespace.php

@@ -20,10 +20,8 @@ function bootstrap() {
 
 	add_action( 'admin_head-index.php', __NAMESPACE__ . '\\set_help_content_fair_planet_urls' );
 
-	// Replace the Planet URL in the legacy WordPress Planet Feed Widget.
+	// Configure the WordPress Events and News widget to use FAIR.
 	add_filter( 'dashboard_secondary_link', __NAMESPACE__ . '\\get_fair_planet_url' );
-
-	// Replace the Planet feed in the legacy WordPress Planet Feed Widget.
 	add_filter( 'dashboard_secondary_feed', __NAMESPACE__ . '\\get_fair_planet_feed' );
 }
 
@@ -215,7 +213,7 @@ function get_fair_planet_feed() : string {
 }
 
 /**
- * Replace the WordPress Planet URL with the Fair Planet URL.
+ * Point the WordPress Planet URL to the Fair Planet URL in the Help -> Content tab on the Dashboard.
  * No available filter for this.
  *
  * @return void

inc/default-repo/namespace.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Prevents calls to the WordPress.org API for the default repository.
+ * Replaces calls to the WordPress.org API with calls to the API of the chosen FAIR repository.
  *
  * @package FAIR
  */
@@ -36,7 +36,7 @@ function get_default_repo_domain() : string {
  * Replace the repository API URLs.
  *
  * Replaces api.wordpress.org with the repository we're using, for the plugins
- * and themes APIs. Only these get passed to AspirePress, as the others are
+ * and themes APIs. Only these get passed to the chosen FAIR repo, as the others are
  * handled in other modules.
  *
  * @param array $args

inc/importers/namespace.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Prevents calls to the WordPress.org API for popular importers.
+ * Replaces calls to the WordPress.org Importer API with calls to the Importer API of the chosen FAIR repository.
  *
  * @package FAIR
  */

inc/salts/namespace.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Prevents calls to the WordPress.org API for salt generation.
+ * Replaces calls to the WordPress.org Secret Key API with locally generated keys and salts.
  *
  * @package FAIR
  */

inc/version-check/namespace.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Prevents calls to the WordPress.org API for version checks.
+ * Replaces calls to the WordPress.org BrowseHappy and ServeHappy APIs with static local data.
  *
  * @package FAIR
  */