diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 5c7bdfdce011..bfafaa6c322c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,6 +1,6 @@ ##### Description diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 00df8ea00017..1fa115667f0b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -18,7 +18,7 @@ assignees: '' ##### Description diff --git a/bin/utils/dart-keywords/README.md b/bin/utils/dart-keywords/README.md index 2d14a81b61d7..8b414c77f411 100644 --- a/bin/utils/dart-keywords/README.md +++ b/bin/utils/dart-keywords/README.md @@ -5,11 +5,11 @@ Running `./save_dart_keywords.sh` from this directory will generate `dart-keywor ## When should the keywords be generated? -`save_dart_keywords.sh` should be run when a new version of Dart is release to update the keywords file. +`save_dart_keywords.sh` should be run when a new version of Dart is released to update the keywords file. The last Dart version that was used to generate the keywords can be found in `dart-version.txt`. -## What does the shellscript do? +## What does the shell script do? 1. run the dart app - `dart run save-dart-keywords.dart` diff --git a/docs/debugging.md b/docs/debugging.md index 76ad96de1867..da8904132daa 100644 --- a/docs/debugging.md +++ b/docs/debugging.md @@ -5,7 +5,7 @@ title: Debugging ## Generation -As a user there may be times when generated outputs don't match your expectations it's unclear why. The CLI supports a `--dry-run` option which may be used to inspect the anticipated file operations without making changes to the file system. +As a user there may be times when generated outputs don't match your expectations and it's unclear why. The CLI supports a `--dry-run` option which may be used to inspect the anticipated file operations without making changes to the file system. Suppose you generate using the `--minimal-update` option, and you notice on subsequent generations of a client that no files have changed. This is by design. diff --git a/modules/openapi-generator/src/main/resources/typescript-aurelia/README.md b/modules/openapi-generator/src/main/resources/typescript-aurelia/README.md index f6fc6e804adc..96ef4d65655f 100644 --- a/modules/openapi-generator/src/main/resources/typescript-aurelia/README.md +++ b/modules/openapi-generator/src/main/resources/typescript-aurelia/README.md @@ -65,5 +65,5 @@ import {operationId} from './symlinkDir'; The CommonJS syntax is as follows: ``` -import localName = require('./symlinkDir')'; +import localName = require('./symlinkDir'); ```