Skip to content

Commit 8b773c4

Browse files
docs: update the README
Co-authored-by: Athan <[email protected]> Signed-off-by: Karan Anand <[email protected]>
1 parent 18f54b6 commit 8b773c4

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/math/base/special/heaviside

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/math/base/special/heaviside/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ The `continuity` parameter may be one of the following values:
214214
- `STDLIB_BASE_HEAVISIDE_CONTINUITY_RIGHT_CONTINUOUS`: if `x == 0`, the function returns `1.0`.
215215
- `STDLIB_BASE_HEAVISIDE_CONTINUITY_DISCONTINUOUS`: if `x == 0`, the function returns `NaN`.
216216

217-
If not provided a valid `continuity` parameter, the function returns `NaN` for `x == 0`, behaving like the discontinuous case.
217+
If provided a `continuity` argument which is not one of the enumeration constants listed above, the function returns `NaN` for `x == 0`, behaving like the discontinuous case.
218218

219219
```c
220220
double stdlib_base_heaviside( const double x, const STDLIB_BASE_HEAVISIDE_CONTINUITY continuity );

0 commit comments

Comments
 (0)