mirror of
https://github.com/woocommerce/woocommerce.git
synced 2025-02-02 05:31:57 +08:00
Docs for the introduced constant classes (#54696)
* Docs for the introduced constant classes * Add changefile(s) from automation for the following project(s): woocommerce * Docs manifest file --------- Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
This commit is contained in:
parent
a9600503d8
commit
c6955ddf57
@ -54,6 +54,7 @@ Available READMe files for the WooCommerce plugin:
|
||||
- [`packages`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/packages/README.md)
|
||||
- [`src`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/README.md)
|
||||
- [`src/Admin/RemoteInboxNotifications`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Admin/RemoteInboxNotifications/README.md)
|
||||
- [`src/Enums`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Enums/README.md)
|
||||
- [`src/Internal`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Internal/README.md)
|
||||
- [`src/Internal/Admin/ProductForm`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Internal/Admin/ProductForm/README.md)blob
|
||||
- [`src/TransientFiles`](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Internal/TransientFiles/README.md)
|
||||
|
@ -3,7 +3,7 @@
|
||||
{
|
||||
"post_title": "WooCommerce developer documentation",
|
||||
"edit_url": "https://github.com/woocommerce/woocommerce/edit/trunk/docs/README.md",
|
||||
"hash": "e2fcc6ad9781cad5abc6ae17f31eae7c930fc07c37848d7a8141fa5bbe13110f",
|
||||
"hash": "f6c49a9bd5838c85a648be084ff5d65326f3394b5c7927a65dd7f0c8bf073c5e",
|
||||
"url": "https://raw.githubusercontent.com/woocommerce/woocommerce/trunk/docs/README.md",
|
||||
"id": "65f434b31529b2793f7f7adcadfec487c797bdd2",
|
||||
"links": {
|
||||
@ -1915,5 +1915,5 @@
|
||||
"categories": []
|
||||
}
|
||||
],
|
||||
"hash": "edfbe17385c28e672d0777fdb92141c0b6e5f820e05d3726f081aa136ad91522"
|
||||
"hash": "beb3b80fda92376b5c05e46850a045fb2503f062e3c7ee12168c7290a0295198"
|
||||
}
|
@ -0,0 +1,4 @@
|
||||
Significance: minor
|
||||
Type: dev
|
||||
|
||||
Adds a new README.md file in the Enums root folder introducing the constant classes and updates the index file referencing it (docs/README.md).
|
16
plugins/woocommerce/src/Enums/README.md
Normal file
16
plugins/woocommerce/src/Enums/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
# WooCommerce Enumerators <!-- omit in toc -->
|
||||
|
||||
This directory contains enumerators used in the WooCommerce plugin. Enumerators are used to define a set of named constants, which can be used to represent a set of possible values.
|
||||
|
||||
The enum classes make it easier to reference string values and avoid typos. They also make the code stricter, make it easier to find the usage of the possible values, centralize them, improve their documentation, and many other advantages that should help developers create related code.
|
||||
|
||||
## Available Enumerators
|
||||
|
||||
- [OrderStatus](./OrderStatus.php) - Enumerates the possible statuses of an order.
|
||||
- [OrderInternalStatus](./OrderInternalStatus.php) - Enumerates the possible internal statuses of an order (when stored in the database).
|
||||
- [ProductType](./ProductType.php) - Enumerates the possible types of a product.
|
||||
- [ProductStatus](./ProductStatus.php) - Enumerates the possible statuses of a product.
|
||||
|
||||
## Contributing
|
||||
|
||||
The WooCommerce plugin contains many string values that still need to be converted to enumerators. Feel free to contribute by creating new classes.
|
Loading…
Reference in New Issue
Block a user