Skip to content

Commit a8b0d58

Browse files
authored
docs: include stdbool, remove backticks in math/base/assert/is-nonnegative-integerf
PR-URL: #2879 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 73c23e2 commit a8b0d58

File tree

1 file changed

+4
-2
lines changed
  • lib/node_modules/@stdlib/math/base/assert/is-nonnegative-integerf

1 file changed

+4
-2
lines changed

lib/node_modules/@stdlib/math/base/assert/is-nonnegative-integerf/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-in
3232

3333
#### isNonNegativeIntegerf( x )
3434

35-
Tests if a finite [single-precision floating-point number][ieee754] is a nonnegative `integer`.
35+
Tests if a finite [single-precision floating-point number][ieee754] is a nonnegative integer.
3636

3737
```javascript
3838
var bool = isNonNegativeIntegerf( 1.0 );
@@ -53,7 +53,7 @@ bool = isNonNegativeIntegerf( -10.0 );
5353

5454
## Notes
5555

56-
- The function assumes a **finite** `number`. If provided positive `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows:
56+
- The function assumes a **finite** number. If provided positive `infinity`, the function will return `true`, when, in fact, the result is undefined. If `x` can be `infinite`, wrap the implementation as follows:
5757

5858
```javascript
5959
function check( x ) {
@@ -141,6 +141,8 @@ bool = isNonNegativeIntegerf( NaN );
141141
Tests if a finite [single-precision floating-point number][ieee754] is a nonnegative integer.
142142

143143
```c
144+
#include <stdbool.h>
145+
144146
bool out = stdlib_base_is_nonnegative_integerf( 1.0f );
145147
// returns true
146148

0 commit comments

Comments
 (0)