Changeset 12481

Timestamp:

10/24/2019 01:17:50 AM (5 years ago)

Author:

johnjamesjacoby

Message:

Docs: fix typos and code comments gone rogue.

This commit fixes a few random typos and weirdly misplaced code comments I stumbled across in the Core Functions file while looking at something else entirely. 🐿

File:

• trunk/src/bp-core/bp-core-functions.php (modified) (13 diffs)

trunk/src/bp-core/bp-core-functions.php

@@ -17 +17 @@
  *
  * @since 1.6.0
- *
  */
 function bp_version() {
@@ -37 +36 @@
  *
  * @since 1.6.0
- *
  */
 function bp_db_version() {
@@ -57 +55 @@
  *
  * @since 1.6.0
- *
  */
 function bp_db_version_raw() {
@@ -237 +234 @@
  * @since 1.6.0
  *
- * @param array $old_args_keys Old argument indexs, keyed to their positions.
+ * @param array $old_args_keys Old argument indexes, keyed to their positions.
  * @param array $func_args     The parameters passed to the originating function.
  * @return array $new_args The parsed arguments.
@@ -322 +319 @@
  * Sanitizes a pagination argument based on both the request override and the
  * original value submitted via a query argument, likely to a template class
- * responsible for limiting the resultset of a template loop.
+ * responsible for limiting the result set of a template loop.
  *
  * @since 2.2.0
@@ -1423 +1420 @@
  *
  * @since 1.1.0
- *
  */
 function bp_core_setup_message() {
@@ -1507 +1503 @@
  * @since 1.0.0
  *
- *       usermeta table.
- *
  * @return false|null Returns false if there is nothing to do.
  */
@@ -1564 +1558 @@
  * @since 1.0.0
  *
- *       representation of the time elapsed.
- *
  * @param int|string $last_activity_date The date of last activity.
  * @param string     $string             A sprintf()-able statement of the form 'active %s'.
@@ -1599 +1591 @@
  * Get the meta_key for a given piece of user metadata
  *
- * BuddyPress stores a number of pieces of userdata in the WordPress central
+ * BuddyPress stores a number of pieces of user data in the WordPress central
  * usermeta table. In order to allow plugins to enable multiple instances of
  * BuddyPress on a single WP installation, BP's usermeta keys are filtered
@@ -3111 +3103 @@
  * @param string                   $email_type Type of email being sent.
  * @param string|array|int|WP_User $to         Either a email address, user ID, WP_User object,
- *                                             or an array containg the address and name.
+ *                                             or an array containing the address and name.
  * @param array                    $args {
  *     Optional. Array of extra parameters.
  *
- *     @type array $tokens Optional. Assocative arrays of string replacements for the email.
+ *     @type array $tokens Optional. Associative arrays of string replacements for the email.
  * }
  * @return bool|WP_Error True if the email was sent successfully. Otherwise, a WP_Error object
@@ -3167 +3159 @@
      * @param string                   $email_type Type of email being sent.
      * @param string|array|int|WP_User $to         Either a email address, user ID, WP_User object,
-     *                                             or an array containg the address and name.
+     *                                             or an array containing the address and name.
      * @param array                    $args {
      *     Optional. Array of extra parameters.
@@ -3221 +3213 @@
      *     Optional. Array of extra parameters.
      *
-     *     @type array $tokens Optional. Assocative arrays of string replacements for the email.
+     *     @type array $tokens Optional. Associative arrays of string replacements for the email.
      * }
      */
@@ -3248 +3240 @@
 
         /**
-         * Fires after BuddyPress has succesfully sent an email.
+         * Fires after BuddyPress has successfully sent an email.
          *
          * @since 2.5.0