Skip to content

Commit e7fbc24

Browse files
committed
docs: fix example code in TSDoc declaration
--- 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: na - 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: passed - task: lint_license_headers status: passed ---
1 parent ed42a4f commit e7fbc24

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

lib/node_modules/@stdlib/math/iter/utils/continued-fraction/docs/types/index.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,10 @@ interface Options {
4949
* @returns result
5050
*
5151
* @example
52+
* var iterContinuedFractionSeq = require( '@stdlib/math/iter/sequences/continued-fraction' );
53+
*
5254
* // Create an iterator for generating continued fraction terms:
53-
* var it = iterContinuedFraction( 3.245 );
55+
* var it = iterContinuedFractionSeq( 3.245 );
5456
*
5557
* // Reconstruct the original value from the terms:
5658
* var v = iterContinuedFraction( it );

lib/node_modules/@stdlib/math/iter/utils/docs/types/index.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ interface Namespace {
3838
* @returns result
3939
*
4040
* @example
41+
* var iterContinuedFractionSeq = require( '@stdlib/math/iter/sequences/continued-fraction' );
42+
*
4143
* // Create an iterator for generating continued fraction terms:
42-
* var it = ns.iterContinuedFraction( 3.245 );
44+
* var it = iterContinuedFractionSeq( 3.245 );
4345
*
4446
* // Reconstruct the original value from the terms:
4547
* var v = ns.iterContinuedFraction( it );

0 commit comments

Comments
 (0)