Skip to content

Commit b2fcb9b

Browse files
Planeshifterkgryte
andauthored
chore: apply suggestions from code review
Co-authored-by: Athan <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]>
1 parent 944d150 commit b2fcb9b

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ The function returns an object with the following properties:
4747
The function accepts the following `options`:
4848

4949
- **releaseType**: a release type for which to generate the changelog.
50-
- **format**: whether to generate a `grouped` changelog where commits are grouped by package or `aggregated` one.
50+
- **format**: changelog format. Must be one of the following:
51+
52+
- `'grouped'`: group commits by package.
53+
- `'aggregated'`: TODO:add description.
5154
- **flags**: `git log` options used to retrieve commits from which to generate the changelog.
5255

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

lib/node_modules/@stdlib/_tools/changelog/parse-commits/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The function accepts the following `options`:
4444
- **dir**: directory for which to parse commits. May be either an absolute path or a path relative to the current working directory. Default: current working directory.
4545
- **issueURL**: issue URL. Default: `https://github.com/stdlib-js/stdlib/issues/`.
4646
- **prURL**: pull request URL. Default: `https://github.com/stdlib-js/stdlib/pull/`.
47-
- **flags**: options passed to invoked `git log` command to retrieve commit messages.
47+
- **flags**: options passed to `git log` when retrieving commit messages.
4848

4949
</section>
5050

lib/node_modules/@stdlib/_tools/changelog/parse-commits/lib/commits.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ function extractCommits( dir, flags ) {
116116
if ( flags ) {
117117
flagNames = objectKeys( flags );
118118
for ( i = 0; i < flagNames.length; i++ ) {
119-
args.push( '--'+flagNames[i]+'='+flags[ flagNames[ i ] ] );
119+
args.push( '--'+flagNames[ i ]+'='+flags[ flagNames[ i ] ] );
120120
}
121121
}
122122
try {

0 commit comments

Comments
 (0)