Skip to content

Commit ab40c8e

Browse files
authored
chore: apply suggestions from code review
Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 5340b8f commit ab40c8e

File tree

1 file changed

+13
-1
lines changed
  • lib/node_modules/@stdlib/stats/base/dists/rayleigh/stdev

1 file changed

+13
-1
lines changed

lib/node_modules/@stdlib/stats/base/dists/rayleigh/stdev/README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ for ( i = 0; i < 10; i++ ) {
145145

146146
#### stdlib_base_dists_rayleigh_stdev( sigma )
147147

148-
Evaluates the stdev for a Rayleigh distribution.
148+
Returns the [standard deviation][standard-deviation] of a [Rayleigh][rayleigh-distribution] distribution with scale `sigma`.
149149

150150
```c
151151
double out = stdlib_base_dists_rayleigh_stdev( 9.0 );
@@ -161,26 +161,38 @@ double stdlib_base_dists_rayleigh_stdev( const double sigma );
161161
```
162162
163163
</section>
164+
164165
<!-- /.usage -->
166+
165167
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
168+
166169
<section class="notes">
170+
167171
</section>
172+
168173
<!-- /.notes -->
174+
169175
<!-- C API usage examples. -->
176+
170177
<section class="examples">
178+
171179
### Examples
180+
172181
```c
173182
#include "stdlib/stats/base/dists/rayleigh/stdev.h"
174183
#include <stdlib.h>
175184
#include <stdio.h>
185+
176186
static double random_uniform( const double min, const double max ) {
177187
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
178188
return min + ( v*(max-min) );
179189
}
190+
180191
int main( void ) {
181192
double sigma;
182193
double y;
183194
int i;
195+
184196
for ( i = 0; i < 25; i++ ) {
185197
sigma = random_uniform( 0.0, 10.0 );
186198
y = stdlib_base_dists_rayleigh_stdev( sigma );

0 commit comments

Comments
 (0)