Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed errors in file documentation syntax. #44629

Merged
merged 2 commits into from Feb 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions plugins/woocommerce/changelog/44629-trunk
@@ -0,0 +1,4 @@
Significance: patch
Type: tweak

Fixed minor errors in file documentation syntax.
4 changes: 2 additions & 2 deletions plugins/woocommerce/src/Admin/API/Init.php
Expand Up @@ -190,8 +190,8 @@ public static function add_data_stores( $data_stores ) {
* object in REST API responses. For use in formatAmount().
*
* @internal
* @param {WP_REST_Response} $response REST response object.
* @returns {WP_REST_Response}
* @param WP_REST_Response $response REST response object.
* @returns WP_REST_Response
*/
public static function add_currency_symbol_to_order_response( $response ) {
$response_data = $response->get_data();
Expand Down
Expand Up @@ -45,10 +45,10 @@ protected function get_block_type_uses_context() {
* - Available on backorder
* - 2 left in stock
*
* @param [bool] $is_in_stock Whether the product is in stock.
* @param [bool] $is_low_stock Whether the product is low in stock.
* @param [int|null] $low_stock_amount The amount of stock that is considered low.
* @param [bool] $is_on_backorder Whether the product is on backorder.
* @param bool $is_in_stock Whether the product is in stock.
* @param bool $is_low_stock Whether the product is low in stock.
* @param int|null $low_stock_amount The amount of stock that is considered low.
* @param bool $is_on_backorder Whether the product is on backorder.
* @return string Stock text.
*/
protected static function getTextBasedOnStock( $is_in_stock, $is_low_stock, $low_stock_amount, $is_on_backorder ) {
Expand Down
Expand Up @@ -50,7 +50,7 @@ public function set_payment_method( $payment_method ) {
/**
* Retrieve the payment method instance for the current set payment method.
*
* @return {\WC_Payment_Gateway|null} An instance of the payment gateway if it exists.
* @return \WC_Payment_Gateway|null An instance of the payment gateway if it exists.
*/
public function get_payment_method_instance() {
$available_gateways = WC()->payment_gateways->get_available_payment_gateways();
Expand Down