Skip to content

Commit 07dead0

Browse files
committed
improve the readability of the documentation
1 parent 9fed64e commit 07dead0

File tree

3 files changed

+17
-16
lines changed

3 files changed

+17
-16
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
Contributions are welcome, if you find a bug please fork from the master branch and submit a pull request.
1+
Contributions are welcome. If you find a bug, please fork from the main branch and submit a pull request.
22

3-
Alternatively you can open an issue however these are likely to take longer to resolve.
3+
Alternatively, you can open an issue; however, these are likely to take longer to resolve.
44

5-
We are not currently looking to add new functionality to the library, however if there is something you believe is missing please open an issue and we can discuss it!
5+
We are not currently looking to add new functionality to the library.
6+
However, if there is something you believe is missing, please open an issue and we can discuss it!

src/Arr.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
class Arr
1313
{
1414
/**
15-
* Determines if $value is an accessible like an array.
15+
* Determines if $value is an accessible-like an array.
1616
*
1717
* @param mixed $value
1818
*
@@ -53,7 +53,7 @@ public static function divide($array): array
5353
}
5454

5555
/**
56-
* Flatten a multi-dimensional array into a single level.
56+
* Flatten a multidimensional array into a single level.
5757
*
5858
* @param Arrayable|array $array
5959
* @param int $depth
@@ -266,7 +266,7 @@ public static function search(array $haystack, $needle, bool $strict = false)
266266
}
267267

268268
/**
269-
* Given a multi-dimensional array, return the first item that has a property $property
269+
* Given a multidimensional array, return the first item that has a property $property
270270
* with value $value.
271271
* An array of properties can be provided to perform deeper finds.
272272
*

src/ArrDots.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
class ArrDots
1313
{
1414
/**
15-
* Implode a multi-dimensional associative array into a single level dots array.
15+
* Implode a multidimensional associative array into a single level dots array.
1616
*
1717
* @param array $array
1818
* @param string $prepend
@@ -35,7 +35,7 @@ public static function implode(array $array, string $prepend = ''): array
3535
}
3636

3737
/**
38-
* Explode a single level dots array into a multi-dimensional associative array.
38+
* Explode a single level dots array into a multidimensional associative array.
3939
*
4040
* @param array $array
4141
*
@@ -131,7 +131,7 @@ public static function remove(&$array, $keys)
131131
}
132132

133133
/**
134-
* Get an item from a multi-dimensional associative array using "dots" notation.
134+
* Get an item from a multidimensional associative array using "dots" notation.
135135
*
136136
* @param ArrayAccess|array $array
137137
* @param string|int $key
@@ -165,7 +165,7 @@ public static function get($array, $key, $default = null)
165165
}
166166

167167
/**
168-
* Get all items from a multi-dimensional associative array using "dots" notation and
168+
* Get all items from a multidimensional associative array using "dots" notation and
169169
* return a flattened "dots" notation array.
170170
*
171171
* @param ArrayAccess|array $array
@@ -214,7 +214,7 @@ public static function collate($array, string $key, string $wildcard = null): ar
214214
}
215215

216216
/**
217-
* Determine if an item or items exist in an multi-dimensional associative array using "dots" notation.
217+
* Determine if an item or items exist in a multidimensional associative array using "dots" notation.
218218
*
219219
* @param ArrayAccess|array $array
220220
* @param string|string[] $keys
@@ -234,7 +234,7 @@ public static function has($array, $keys, string $wildcard = null): bool
234234
foreach ((array)$keys as $key) {
235235
$array = $originalArray;
236236

237-
// If the array has the key carry on
237+
// If the array has the key, carry on
238238
if (Arr::exists($array, $key)) {
239239
continue;
240240
}
@@ -244,7 +244,7 @@ public static function has($array, $keys, string $wildcard = null): bool
244244
foreach ($segments as $k => $segment) {
245245
// If the segment is a wildcard
246246
if ($segment === $wildcard && !empty($array)) {
247-
// If this is the last segment then the array has the key
247+
// If this is the last segment, then the array has the key
248248
if ($k + 1 === count($segments)) {
249249
break;
250250
}
@@ -292,7 +292,7 @@ public static function pull(&$array, string $key, $default = null)
292292
}
293293

294294
/**
295-
* Set an multi-dimensional associative array item to $value using "dots" notation.
295+
* Set a multidimensional associative array item to $value using "dots" notation.
296296
*
297297
* @param array $array
298298
* @param ?string $key
@@ -324,7 +324,7 @@ public static function set(array &$array, ?string $key, $value)
324324
}
325325

326326
/**
327-
* Get a subset of items from an multi-dimensional associative $array using "dots" notation for $keys.
327+
* Get a subset of items from a multidimensional associative $array using "dots" notation for $keys.
328328
*
329329
* @param array $array
330330
* @param string|string[] $keys
@@ -339,7 +339,7 @@ public static function only(array $array, $keys): array
339339
}
340340

341341
/**
342-
* Given a multi-dimensional array, return the first item that has a property $property
342+
* Given a multidimensional array, return the first item that has a property $property
343343
* with value $value.
344344
* An array of properties can be provided to perform deeper finds.
345345
*

0 commit comments

Comments
 (0)