Skip to content

Commit e313199

Browse files
committed
docs: improve clarity in README
--- 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: na - task: lint_javascript_src status: na - 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: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent d8bb224 commit e313199

File tree

1 file changed

+1
-1
lines changed
  • lib/node_modules/@stdlib/stats/base/dists/bradford/quantile

1 file changed

+1
-1
lines changed

lib/node_modules/@stdlib/stats/base/dists/bradford/quantile/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ y = quantile( -1.0, 0.5 );
8888
// returns NaN
8989
```
9090

91-
If provided `c <= 0`, the function returns `NaN`.
91+
If provided a shape parameter `c <= 0`, the function returns `NaN`.
9292

9393
```javascript
9494
var y = quantile( 0.5, 0.0 );

0 commit comments

Comments
 (0)