updated doc

yuvimittal · yuvimittal · commit 4770cb7f9441 · 2025-02-11T15:32:01.000+05:30
---
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: na
  - 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
---

---
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: na
  - 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
---
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/mode/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/mode/src/main.c
@@ -20,7 +20,7 @@
 #include "stdlib/math/base/assert/is_nan.h"
 
 /**
-* Returns the mode of a planck distribution.
+*Returns the mode of a Planck distribution with shape parameter `lambda`.
 *
 * @param lambda   shape parameter
 * @return         mode or NaN if invalid input

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`#include "stdlib/math/base/assert/is_nan.h"`
`21`	`21`
`22`	`22`	`/**`
`23`		`-* Returns the mode of a planck distribution.`
	`23`	+*Returns the mode of a Planck distribution with shape parameter `lambda`.
`24`	`24`	`*`
`25`	`25`	`* @param lambda shape parameter`
`26`	`26`	`* @return mode or NaN if invalid input`