Skip to content

Commit ec60fa2

Browse files
committed
docs: fix hypotf description across package
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 69832d0 commit ec60fa2

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

lib/node_modules/@stdlib/math/base/special/fast/hypotf/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# hypotf
2222

23-
> Compute the [hypotenuse][hypotenuse] of a single-precision floating-point number.
23+
> Compute the [hypotenuse][hypotenuse] of two single-precision floating-point numbers.
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -42,7 +42,7 @@ var hypotf = require( '@stdlib/math/base/special/fast/hypotf' );
4242

4343
#### hypotf( x, y )
4444

45-
Computes the [hypotenuse][hypotenuse] of a single-precision floating-point number.
45+
Computes the [hypotenuse][hypotenuse] of two single-precision floating-point numbers.
4646

4747
```javascript
4848
var h = hypotf( -5.0, 12.0 );
@@ -131,7 +131,7 @@ logEachMap( 'h(%d,%d) = %0.4f', x, y, hypotf );
131131

132132
#### stdlib_base_fast_hypotf( x, y )
133133

134-
Computes the hypotenuse of a single-precision floating-point number.
134+
Computes the hypotenuse of two single-precision floating-point numbers.
135135

136136
```c
137137
float h = stdlib_base_fast_hypotf( 5.0f, 12.0f );

lib/node_modules/@stdlib/math/base/special/fast/hypotf/docs/repl.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
{{alias}}( x, y )
3-
Computes the hypotenuse of a single-precision floating-point number.
3+
Computes the hypotenuse of two single-precision floating-point numbers.
44

55
Parameters
66
----------

lib/node_modules/@stdlib/math/base/special/fast/hypotf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Computes the hypotenuse of a single-precision floating-point number.
22+
* Computes the hypotenuse of two single-precision floating-point numbers.
2323
*
2424
* @param x - number
2525
* @param y - number

lib/node_modules/@stdlib/math/base/special/fast/hypotf/include/stdlib/math/base/special/fast/hypotf.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Computes the hypotenuse of a single-precision floating-point number.
30+
* Computes the hypotenuse of two single-precision floating-point numbers.
3131
*/
3232
float stdlib_base_fast_hypotf( const float x, const float y );
3333

lib/node_modules/@stdlib/math/base/special/fast/hypotf/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Compute the hypotenuse of a single-precision floating-point number.
22+
* Compute the hypotenuse of two single-precision floating-point numbers.
2323
*
2424
* @module @stdlib/math/base/special/fast/hypotf
2525
*

lib/node_modules/@stdlib/math/base/special/fast/hypotf/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var sqrtf = require( '@stdlib/math/base/special/sqrtf' );
2626
// MAIN //
2727

2828
/**
29-
* Computes the hypotenuse of a single-precision floating-point number.
29+
* Computes the hypotenuse of two single-precision floating-point numbers.
3030
*
3131
* @param {number} x - number
3232
* @param {number} y - number

lib/node_modules/@stdlib/math/base/special/fast/hypotf/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
#include "stdlib/math/base/special/sqrtf.h"
2121

2222
/**
23-
* Computes the hypotenuse of a single-precision floating-point number.
23+
* Computes the hypotenuse of two single-precision floating-point numbers.
2424
*
2525
* @param x number
2626
* @param y number
2727
* @return hypotenuse
2828
*
2929
* @example
3030
* float h = stdlib_base_fast_hypotf( 5.0f, 12.0f );
31-
* // returns 13.0
31+
* // returns 13.0f
3232
*/
3333
float stdlib_base_fast_hypotf( const float x, const float y ) {
3434
return stdlib_base_sqrtf( ( x * x ) + ( y * y ) );

0 commit comments

Comments
 (0)