Skip to content

Commit e218bf5

Browse files
committed
Update docs
Signed-off-by: Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
1 parent 4c36694 commit e218bf5

4 files changed

Lines changed: 5 additions & 11 deletions

File tree

docs/links/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Useful links for FastForward Config:
55

66
- `GitHub Repository <https://github.com/php-fast-forward/config>`_
77
- `API Reference (README) <https://github.com/php-fast-forward/config#readme>`_
8-
- `Live Coverage Report <../public/coverage/index.html>`_
8+
- `Live Coverage Report <https://php-fast-forward.github.io/config/coverage/index.html>`_
9+
- `Testdox Report <https://php-fast-forward.github.io/config/coverage/testdox.html>`_
910
- `Packagist <https://packagist.org/packages/fast-forward/config>`_
1011
- `PSR-16 Simple Cache <https://www.php-fig.org/psr/psr-16/>`_
1112
- `Laminas Config Aggregator <https://docs.laminas.dev/laminas-config-aggregator/>`_

src/AggregateConfig.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ public function __construct(ConfigInterface ...$configs)
5353
*
5454
* This method SHALL initialize a new ArrayConfig instance and populate it
5555
* with the values from each provided configuration source.
56-
*
5756
* It MUST return a fully merged configuration in the form of a ConfigInterface implementation.
5857
*
5958
* @return ConfigInterface the resulting merged configuration object

src/ArrayConfig.php

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,7 @@ public function remove(string $key): void
138138
*
139139
* This method SHALL return an iterator where each key represents
140140
* the nested path in dot notation, and each value is the corresponding value.
141-
*
142-
* For example:
143-
* ['database' => ['host' => 'localhost']] becomes ['database.host' => 'localhost'].
141+
* For example ['database' => ['host' => 'localhost']] becomes ['database.host' => 'localhost'].
144142
*
145143
* @return Traversable<string, mixed> an iterator of flattened key-value pairs
146144
*/

src/Helper/ConfigHelper.php

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ final class ConfigHelper
3737
* This constructor is private to prevent instantiation of the class.
3838
*
3939
* The class MUST be used in a static context only.
40-
*
41-
* @codeCoverageIgnore
4240
*/
4341
private function __construct()
4442
{
@@ -129,10 +127,8 @@ public static function normalize(array $config): array
129127
*
130128
* This method SHALL recursively iterate through the nested array structure
131129
* and convert it into a flat representation where keys reflect the nested path.
132-
*
133-
* For example:
134-
* Input: ['database' => ['host' => 'localhost']]
135-
* Output: ['database.host' => 'localhost']
130+
* A value like ['database' => ['host' => 'localhost']] SHALL be transformed into
131+
* ['database.host' => 'localhost'].
136132
*
137133
* @param array $config the configuration array to flatten
138134
* @param string $rootKey (Optional) The root key prefix for recursive calls

0 commit comments

Comments
 (0)