[Accessibility] Fix typos in inline documentation in woocommerce client, includes, and lib folders (#50739)

* Fix typo in inline doc in woocommerce client, includes, and lib folders

* Fix typo in comment

* Uppercase the Brazilian word

---------

Co-authored-by: Darin Kotter <darin.kotter@gmail.com>
Co-authored-by: Néstor Soriano <konamiman@konamiman.com>
This commit is contained in:
Gabriel Manussakis 2024-08-27 11:23:04 -03:00 committed by GitHub
parent 1364adb690
commit 2ebbe68555
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
20 changed files with 28 additions and 24 deletions

View File

@ -72,7 +72,7 @@ pnpm run --filter=@woocommerce/block-library test
Here is a collection of scripts that can help when developing the React-based admin interface. Here is a collection of scripts that can help when developing the React-based admin interface.
```bash ```bash
# Create a develoment build of the React-based admin client. # Create a development build of the React-based admin client.
pnpm --filter=@woocommerce/admin-library dev pnpm --filter=@woocommerce/admin-library dev
# Create and watch a development build of the React-based admin client. # Create and watch a development build of the React-based admin client.
pnpm --filter=@woocommerce/admin-library start pnpm --filter=@woocommerce/admin-library start

View File

@ -0,0 +1,4 @@
Significance: minor
Type: tweak
Fix typo in inline doc in woocommerce client, includes, and lib folders.

View File

@ -201,7 +201,7 @@ $admin-theme-color: var(--wp-admin-theme-color);
} }
/*------------------------------------------------------------------------------ /*------------------------------------------------------------------------------
Subscriptons Header Subscriptions Header
------------------------------------------------------------------------------*/ ------------------------------------------------------------------------------*/
.wc-helper { .wc-helper {
@ -356,7 +356,7 @@ $admin-theme-color: var(--wp-admin-theme-color);
} }
/*------------------------------------------------------------------------------ /*------------------------------------------------------------------------------
Subscripton table Subscription table
------------------------------------------------------------------------------*/ ------------------------------------------------------------------------------*/
.wc-helper { .wc-helper {

View File

@ -191,7 +191,7 @@
// enable if you want key and mouse events to be disabled for content that is blocked // enable if you want key and mouse events to be disabled for content that is blocked
bindEvents: true, bindEvents: true,
// be default blockUI will supress tab navigation from leaving blocking content // by default blockUI will suppress tab navigation from leaving blocking content
// (if bindEvents is true) // (if bindEvents is true)
constrainTabKey: true, constrainTabKey: true,
@ -286,7 +286,7 @@
var z = opts.baseZ; var z = opts.baseZ;
// blockUI uses 3 layers for blocking, for simplicity they are all used on every platform; // blockUI uses 3 layers for blocking, for simplicity they are all used on every platform;
// layer1 is the iframe layer which is used to supress bleed through of underlying content // layer1 is the iframe layer which is used to suppress bleed through of underlying content
// layer2 is the overlay layer which has opacity and a wait cursor (by default) // layer2 is the overlay layer which has opacity and a wait cursor (by default)
// layer3 is the message content that is displayed while blocking // layer3 is the message content that is displayed while blocking
var lyr1, lyr2, lyr3, s; var lyr1, lyr2, lyr3, s;

View File

@ -705,7 +705,7 @@ var PhotoSwipeUI_Default =
}, 50); }, 50);
} }
// toogle pswp--fs class on root element // toggle pswp--fs class on root element
framework[ (_fullscrenAPI.isFullscreen() ? 'add' : 'remove') + 'Class' ](pswp.template, 'pswp--fs'); framework[ (_fullscrenAPI.isFullscreen() ? 'add' : 'remove') + 'Class' ](pswp.template, 'pswp--fs');
}; };

View File

@ -1413,7 +1413,7 @@ abstract class WC_Abstract_Order extends WC_Abstract_Legacy_Order {
private function get_temporary_coupon( WC_Order_Item_Coupon $coupon_item ): WC_Coupon { private function get_temporary_coupon( WC_Order_Item_Coupon $coupon_item ): WC_Coupon {
$coupon_object = new WC_Coupon(); $coupon_object = new WC_Coupon();
// Since WooCommerce 8.7 a succint 'coupon_info' line item meta entry is created // Since WooCommerce 8.7 a succinct 'coupon_info' line item meta entry is created
// whenever a coupon is applied to an order. Previously a more verbose 'coupon_data' was created. // whenever a coupon is applied to an order. Previously a more verbose 'coupon_data' was created.
$coupon_info = $coupon_item->get_meta( 'coupon_info', true ); $coupon_info = $coupon_item->get_meta( 'coupon_info', true );

View File

@ -85,7 +85,7 @@ class WC_Coupon extends WC_Legacy_Coupon {
* Error message. * Error message.
* *
* This property should not be considered public API, and should not be accessed directly. * This property should not be considered public API, and should not be accessed directly.
* It is being added to supress PHP > 8.0 warnings against dynamic property creation, and all access * It is being added to suppress PHP > 8.0 warnings against dynamic property creation, and all access
* should be through the getter and setter methods, namely `get_error_message()` and `set_error_message()`. * should be through the getter and setter methods, namely `get_error_message()` and `set_error_message()`.
* In the future, the access modifier may be changed back to protected. * In the future, the access modifier may be changed back to protected.
* *

View File

@ -633,7 +633,7 @@ class WC_Geo_IP {
); );
/** /**
* Contry names. * Country names.
* *
* @var array * @var array
*/ */

View File

@ -137,7 +137,7 @@ class WC_CLI_COM_Command {
* # force connecting to WCCOM even if site is already connected. * # force connecting to WCCOM even if site is already connected.
* $ wp wc com connect --force * $ wp wc com connect --force
* *
* # Pass password to comman. * # Pass password to command.
* $ wp wc com connect --password=PASSWORD * $ wp wc com connect --password=PASSWORD
* *
* @param array $args Positional arguments to include when calling the command. * @param array $args Positional arguments to include when calling the command.

View File

@ -262,7 +262,7 @@ class WC_Product_CSV_Exporter extends WC_CSV_Batch_Exporter {
* @since 3.1.0 * @since 3.1.0
* *
* @param array $row An associative array with the data of a single row in the CSV file. * @param array $row An associative array with the data of a single row in the CSV file.
* @param WC_Product $product The product object correspnding to the current row. * @param WC_Product $product The product object corresponding to the current row.
* @param WC_Product_CSV_Exporter $exporter The instance of the CSV exporter. * @param WC_Product_CSV_Exporter $exporter The instance of the CSV exporter.
*/ */
return apply_filters( 'woocommerce_product_export_row_data', $row, $product, $this ); return apply_filters( 'woocommerce_product_export_row_data', $row, $product, $this );

View File

@ -198,7 +198,7 @@ class WC_Product_CSV_Importer extends WC_Product_Importer {
return absint( $original_id ); return absint( $original_id );
} }
// See if the given ID maps to a valid product allready. // See if the given ID maps to a valid product already.
$existing_id = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_type IN ( 'product', 'product_variation' ) AND ID = %d;", $id ) ); // WPCS: db call ok, cache ok. $existing_id = $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->posts} WHERE post_type IN ( 'product', 'product_variation' ) AND ID = %d;", $id ) ); // WPCS: db call ok, cache ok.
if ( $existing_id ) { if ( $existing_id ) {

View File

@ -91,7 +91,7 @@ interface WC_Queue_Interface {
public function cancel_all( $hook, $args = array(), $group = '' ); public function cancel_all( $hook, $args = array(), $group = '' );
/** /**
* Get the date and time for the next scheduled occurence of an action with a given hook * Get the date and time for the next scheduled occurrence of an action with a given hook
* (an optionally that matches certain args and group), if any. * (an optionally that matches certain args and group), if any.
* *
* @param string $hook The hook that the job will trigger. * @param string $hook The hook that the job will trigger.

View File

@ -1065,7 +1065,7 @@ class WC_REST_Product_Reviews_Controller extends WC_REST_Controller {
} }
/** /**
* Get the reivew, if the ID is valid. * Get the review, if the ID is valid.
* *
* @since 3.5.0 * @since 3.5.0
* @param int $id Supplied ID. * @param int $id Supplied ID.

View File

@ -53,7 +53,7 @@ class WC_REST_Product_Shipping_Classes_Controller extends WC_REST_Product_Shippi
} }
/** /**
* Callback fuction for the slug-suggestion endpoint. * Callback function for the slug-suggestion endpoint.
* *
* @param WP_REST_Request $request Full details about the request. * @param WP_REST_Request $request Full details about the request.
* @return string The suggested slug. * @return string The suggested slug.

View File

@ -446,7 +446,7 @@ class WC_REST_Product_Variations_Controller extends WC_REST_Product_Variations_V
if ( is_wp_error( $upload ) ) { if ( is_wp_error( $upload ) ) {
/** /**
* Filter to check if it should supress the image upload error, false by default. * Filter to check if it should suppress the image upload error, false by default.
* *
* @since 4.5.0 * @since 4.5.0
* @param bool false If it should suppress. * @param bool false If it should suppress.

View File

@ -232,7 +232,7 @@ class WC_REST_Products_Controller extends WC_REST_Products_V2_Controller {
} }
if ( wc_product_sku_enabled() ) { if ( wc_product_sku_enabled() ) {
// Do a partial match for a sku. Supercedes sku parameter that does exact matching. // Do a partial match for a sku. Supersedes sku parameter that does exact matching.
if ( ! empty( $request['search_sku'] ) ) { if ( ! empty( $request['search_sku'] ) ) {
// Store this for use in the query clause filters. // Store this for use in the query clause filters.
$this->search_sku_in_product_lookup_table = $request['search_sku']; $this->search_sku_in_product_lookup_table = $request['search_sku'];

View File

@ -1833,7 +1833,7 @@ function wc_uasort_comparison( $a, $b ) {
} }
/** /**
* Sort values based on ascii, usefull for special chars in strings. * Sort values based on ascii, useful for special chars in strings.
* *
* @param string $a First value. * @param string $a First value.
* @param string $b Second value. * @param string $b Second value.
@ -2524,7 +2524,7 @@ function wc_selected( $value, $options ) {
* Retrieves the MySQL server version. Based on $wpdb. * Retrieves the MySQL server version. Based on $wpdb.
* *
* @since 3.4.1 * @since 3.4.1
* @return array Vesion information. * @return array Version information.
*/ */
function wc_get_server_database_version() { function wc_get_server_database_version() {
global $wpdb; global $wpdb;

View File

@ -237,7 +237,7 @@ function wc_set_loop_prop( $prop, $value = '' ) {
} }
/** /**
* Set the current visbility for a product in the woocommerce_loop global. * Set the current visibility for a product in the woocommerce_loop global.
* *
* @since 4.4.0 * @since 4.4.0
* @param int $product_id Product it to cache visibility for. * @param int $product_id Product it to cache visibility for.
@ -3805,7 +3805,7 @@ function wc_empty_cart_message() {
// This adds the cart-empty classname to the notice to preserve backwards compatibility (for styling purposes etc). // This adds the cart-empty classname to the notice to preserve backwards compatibility (for styling purposes etc).
$notice = str_replace( 'class="woocommerce-info"', 'class="cart-empty woocommerce-info"', $notice ); $notice = str_replace( 'class="woocommerce-info"', 'class="cart-empty woocommerce-info"', $notice );
// Return the notice within a consistent wrapper element. This is targetted by some scripts such as cart.js. // Return the notice within a consistent wrapper element. This is targeted by some scripts such as cart.js.
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<div class="wc-empty-cart-message">' . $notice . '</div>'; echo '<div class="wc-empty-cart-message">' . $notice . '</div>';
} }

View File

@ -416,7 +416,7 @@ function wc_update_209_brazillian_state() {
// phpcs:disable WordPress.DB.SlowDBQuery // phpcs:disable WordPress.DB.SlowDBQuery
// Update brazillian state codes. // Update Brazilian state codes.
$wpdb->update( $wpdb->update(
$wpdb->postmeta, $wpdb->postmeta,
array( array(
@ -2598,7 +2598,7 @@ function wc_update_770_remove_multichannel_marketing_feature_options() {
/** /**
* Migrate transaction data which was being incorrectly stored in the postmeta table to HPOS tables. * Migrate transaction data which was being incorrectly stored in the postmeta table to HPOS tables.
* *
* @return bool Whether there are pending migration recrods. * @return bool Whether there are pending migration records.
*/ */
function wc_update_810_migrate_transactional_metadata_for_hpos() { function wc_update_810_migrate_transactional_metadata_for_hpos() {
global $wpdb; global $wpdb;

View File

@ -789,7 +789,7 @@ class MobileDetect
'SamsungBrowser' => 'SamsungBrowser/[VER]', 'SamsungBrowser' => 'SamsungBrowser/[VER]',
'Iron' => 'Iron/[VER]', 'Iron' => 'Iron/[VER]',
// @note: Safari 7534.48.3 is actually Version 5.1. // @note: Safari 7534.48.3 is actually Version 5.1.
// @note: On BlackBerry the Version is overwriten by the OS. // @note: On BlackBerry the Version is overwritten by the OS.
'Safari' => ['Version/[VER]', 'Safari/[VER]'], 'Safari' => ['Version/[VER]', 'Safari/[VER]'],
'Skyfire' => 'Skyfire/[VER]', 'Skyfire' => 'Skyfire/[VER]',
'Tizen' => 'Tizen/[VER]', 'Tizen' => 'Tizen/[VER]',