Skip to content

Commit 2250083

Browse files
committed
chore: add directives to disable running examples
--- 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 ---
1 parent a81d07c commit 2250083

File tree

1 file changed

+10
-0
lines changed
  • lib/node_modules/@stdlib/_tools/changelog/generate

1 file changed

+10
-0
lines changed

lib/node_modules/@stdlib/_tools/changelog/generate/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ var generate = require( '@stdlib/_tools/changelog/generate' );
3434

3535
Generates a Markdown formatted changelog for a specified package.
3636

37+
<!-- run-disable -->
38+
3739
```javascript
3840
var changelog = generate( '@stdlib/assert/contains' );
3941
// returns {...}
@@ -57,6 +59,8 @@ The function accepts the following `options`:
5759

5860
By default, the changelog is generated for a non-release. To generate a changelog for an upcoming release, provide a valid release type:
5961

62+
<!-- run-disable -->
63+
6064
```javascript
6165
var changelog = generate( '@stdlib/assert/contains', {
6266
'releaseType': 'patch'
@@ -83,6 +87,8 @@ The following release types are supported:
8387

8488
By default, the function generates a `grouped` changelog for namespace packages and an `aggregated` changelog for non-namespace packages. To specify a desired output format, set the `format` option:
8589

90+
<!-- run-disable -->
91+
8692
```javascript
8793
// Changelog grouped by individual packages:
8894
var changelog = generate( '@stdlib/math/base/utils', {
@@ -99,6 +105,8 @@ changelog = generate( '@stdlib/math/base/utils', {
99105

100106
When generating a changelog, the function uses `git log` to retrieve the commits from which to assemble a set of changes. The `flags` option allows passing options to directly to the `git log` command (e.g., to generate a changelog for a specified time interval or for an individual contributor).
101107

108+
<!-- run-disable -->
109+
102110
```javascript
103111
var changelog = generate( '@stdlib/ndarray', {
104112
'flags': {
@@ -129,6 +137,8 @@ changelog = generate( '@stdlib/ndarray', {
129137

130138
## Examples
131139

140+
<!-- run-disable -->
141+
132142
```javascript
133143
var generate = require( '@stdlib/_tools/changelog/generate' );
134144

0 commit comments

Comments
 (0)