Skip to content

Commit 4765dc1

Browse files
committed
docs: add missing comments 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 8d2e932 commit 4765dc1

File tree

1 file changed

+12
-1
lines changed
  • lib/node_modules/@stdlib/stats/strided/snancount

1 file changed

+12
-1
lines changed

lib/node_modules/@stdlib/stats/strided/snancount/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,18 +152,24 @@ console.log( v );
152152

153153
<!-- /.examples -->
154154

155+
<!-- C interface documentation. -->
156+
155157
* * *
156158

157159
<section class="c">
158160

159161
## C APIs
160162

163+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
164+
161165
<section class="intro">
162166

163167
</section>
164168

165169
<!-- /.intro -->
166170

171+
<!-- C usage documentation. -->
172+
167173
<section class="usage">
168174

169175
### Usage
@@ -219,6 +225,10 @@ CBLAS_INT stdlib_strided_snancount_ndarray( const CBLAS_INT N, const float *X, c
219225

220226
<!-- /.usage -->
221227

228+
229+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
230+
231+
222232
<section class="notes">
223233

224234
### Notes
@@ -229,13 +239,14 @@ CBLAS_INT stdlib_strided_snancount_ndarray( const CBLAS_INT N, const float *X, c
229239

230240
<!-- /.notes -->
231241

242+
<!-- C API usage examples. -->
243+
232244
<section class="examples">
233245

234246
### Examples
235247

236248
```c
237249
#include "stdlib/stats/strided/snancount.h"
238-
#include <stdint.h>
239250
#include <stdio.h>
240251

241252
int main( void ) {

0 commit comments

Comments
 (0)