Skip to content

Commit

Permalink
Fixed errors in file documentation syntax. (#44629)
Browse files Browse the repository at this point in the history
* Fixed errors in file documentation syntax.

* Add changefile(s) from automation for the following project(s): woocommerce

---------

Co-authored-by: github-actions <github-actions@github.com>
  • Loading branch information
2 people authored and Konamiman committed Mar 13, 2024
1 parent c2d2145 commit 7e75c12
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
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

0 comments on commit 7e75c12

Please sign in to comment.