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.

Sign up for GitHub

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

[NFC] Docblocks - Remove 'experimental' comments and other copy-edits #27802

Merged
merged 1 commit into from
Oct 13, 2023
Merged

[NFC] Docblocks - Remove 'experimental' comments and other copy-edits #27802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions CRM/Utils/Hook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ public static function xmlMenu(&$files) {
}

/**
* (Experimental) This hook is called when build the menu table.
* This hook is called when building the menu table.
*
* @param array $items
* List of records to include in menu table.
Expand Down Expand Up @@ -1176,7 +1176,7 @@ public static function mailingGroups(&$form, &$groups, &$mailings) {
}

/**
* (Experimental) Modify the list of template-types used for CiviMail composition.
* Modify the list of template-types used for CiviMail composition.
*
* @param array $types
* Sequentially indexed list of template types. Each type specifies:
Expand Down Expand Up @@ -1864,10 +1864,9 @@ public static function buildGroupContactCache(array $savedSearch, int $groupID,
}

/**
* (EXPERIMENTAL) Scan extensions for a list of auto-registered interfaces.
* Scan extensions for a list of auto-registered interfaces.
*
* This hook is currently experimental. It is a means to implementing `mixin/scan-classes@1`.
* If there are no major difficulties circa 5.55, then it can be marked stable.
* @see mixin/scan-classes@1
*
* @param string[] $classes
* List of classes which may be of interest to the class-scanner.
Expand Down Expand Up @@ -2670,7 +2669,7 @@ public static function alterResourceSettings(&$data) {
}

/**
* EXPERIMENTAL: This hook allows one to register additional Angular modules
* Register Angular modules
*
* @param array $angularModules
* List of modules. Each module defines:
Expand Down
2 changes: 1 addition & 1 deletion ext/afform/core/Civi/Afform/AngularDependencyMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
namespace Civi\Afform;

/**
* Class AngularDependencyMapper
* Class used to calculate Afform Angular dependencies.
* @package Civi\Afform
*/
class AngularDependencyMapper {
Expand Down
12 changes: 6 additions & 6 deletions ext/afform/core/Civi/Api4/Utils/AfformFormatTrait.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ trait AfformFormatTrait {

/**
* Controls the return format of the "layout" property
* - html will return layout html as-is.
* - shallow will convert most html to an array, but leave tag attributes and af-markup containers alone.
* - deep will attempt to convert all html to an array, including tag attributes.
* - "html" will return layout html as-is.
* - "shallow" will convert most html to an array, but leave tag attributes and af-markup containers alone.
* - "deep" will attempt to convert all html to an array, including tag attributes.
*
* @var string
* @options html,shallow,deep
Expand All @@ -26,10 +26,10 @@ trait AfformFormatTrait {
/**
* Optionally manage whitespace for the "layout" property
*
* This option will strip whitepace from the returned layout array for "get" actions,
* and will auto-indent the aff.html for "save" actions.
* This option will strip whitepace from the returned layout array for `get` actions,
* and will auto-indent the aff.html for `save` actions.
*
* Note: currently this has no affect on "get" with "html" return format, which returns html as-is.
* Note: Has no effect on `get` with "html" return format, which returns html as-is.
*
* @var bool
*/
Expand Down