Skip to content

docs: align description openers in three array/base/assert cast packages #12207

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

Closed
Planeshifter wants to merge 3 commits into from
Closed

docs: align description openers in three array/base/assert cast packages #12207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f81e0b
docs: rephrase description in `array/base/assert/is-mostly-safe-data-…
claude May 20, 2026
22224df
docs: rephrase description in `array/base/assert/is-safe-data-type-cast`
claude May 20, 2026
6b32993
docs: rephrase description in `array/base/assert/is-same-kind-data-ty…
claude May 20, 2026
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
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-mostly-safe-data-type-cast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# isMostlySafeCast

> Determine whether an array [data type][@stdlib/array/dtypes] can be safely cast or, for floating-point data types, downcast to another array [data type][@stdlib/array/dtypes].
> Test if an array [data type][@stdlib/array/dtypes] can be safely cast or, for floating-point data types, downcast to another array [data type][@stdlib/array/dtypes].

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

Expand Down
5 changes: 2 additions & 3 deletions lib/node_modules/@stdlib/array/base/assert/is-mostly-safe-data-type-cast/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

{{alias}}( from, to )
Returns a boolean indicating whether a provided array data type can be
safely cast or, for floating-point data types, downcast to another array
data type.
Tests if a provided array data type can be safely cast or, for
floating-point data types, downcast to another array data type.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-mostly-safe-data-type-cast/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/array/base/assert/is-mostly-safe-data-type-cast",
"version": "0.0.0",
"description": "Determine if an array data type can be safely cast or, for floating-point data types, downcast to another array data type.",
"description": "Test if an array data type can be safely cast or, for floating-point data types, downcast to another array data type.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-safe-data-type-cast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# isSafeCast

> Determine whether an array [data type][@stdlib/array/dtypes] can be safely cast to another array [data type][@stdlib/array/dtypes].
> Test if an array [data type][@stdlib/array/dtypes] can be safely cast to another array [data type][@stdlib/array/dtypes].

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/array/base/assert/is-safe-data-type-cast/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

{{alias}}( from, to )
Returns a boolean indicating whether a provided array data type can be
safely cast to another array data type.
Tests if a provided array data type can be safely cast to another array
data type.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-safe-data-type-cast/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/array/base/assert/is-safe-data-type-cast",
"version": "0.0.0",
"description": "Determine if an array data type can be safely cast to another array data type.",
"description": "Test if an array data type can be safely cast to another array data type.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-same-kind-data-type-cast/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ limitations under the License.

# isSameKindCast

> Determine whether an array [data type][@stdlib/array/dtypes] can be safely cast to, or is of the same "kind" as, another array [data type][@stdlib/array/dtypes].
> Test if an array [data type][@stdlib/array/dtypes] can be safely cast to, or is of the same "kind" as, another array [data type][@stdlib/array/dtypes].

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/array/base/assert/is-same-kind-data-type-cast/docs/repl.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

{{alias}}( from, to )
Returns a boolean indicating whether a provided array data type can be
safely cast to, or is of the same "kind" as, another array data type.
Tests if a provided array data type can be safely cast to, or is of the
same "kind" as, another array data type.

Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/array/base/assert/is-same-kind-data-type-cast/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@stdlib/array/base/assert/is-same-kind-data-type-cast",
"version": "0.0.0",
"description": "Determine if an array data type can be safely cast to, or is of the same kind as, another array data type.",
"description": "Test if an array data type can be safely cast to, or is of the same kind as, another array data type.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
Expand Down