Skip to content

Commit f6b9624

Browse files
authored
normalize the help text (#1304)
1 parent d0db2f9 commit f6b9624

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

bin/dartdoc.dart

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -180,39 +180,39 @@ ArgParser _createArgsParser() {
180180
help: 'Display progress indications to console stdout', negatable: false);
181181
parser.addOption('sdk-readme',
182182
help:
183-
'Path to the SDK description file. Use if generating Dart SDK docs.');
183+
'Path to the SDK description file; use if generating Dart SDK docs.');
184184
parser.addOption('input',
185-
help: 'Path to source directory', defaultsTo: Directory.current.path);
185+
help: 'Path to source directory.', defaultsTo: Directory.current.path);
186186
parser.addOption('output',
187187
help: 'Path to output directory.', defaultsTo: defaultOutDir);
188188
parser.addOption('header',
189189
allowMultiple: true, help: 'path to file containing HTML text.');
190190
parser.addOption('footer',
191191
allowMultiple: true, help: 'path to file containing HTML text.');
192192
parser.addOption('exclude',
193-
allowMultiple: true, help: 'library names to ignore');
193+
allowMultiple: true, help: 'Library names to ignore.');
194194
parser.addOption('include',
195-
allowMultiple: true, help: 'library names to generate docs for');
195+
allowMultiple: true, help: 'Library names to generate docs for.');
196196
parser.addOption('include-external',
197197
allowMultiple: true,
198-
help: 'additional (external) dart files to include, use "dir/fileName", '
199-
'as in lib/material.dart');
198+
help: 'Additional (external) dart files to include; use "dir/fileName", '
199+
'as in lib/material.dart.');
200200
parser.addOption('hosted-url',
201201
help:
202202
'URL where the docs will be hosted (used to generate the sitemap).');
203203
parser.addOption('example-path-prefix',
204-
help: 'Prefix for @example paths. Default is project root.');
204+
help: 'Prefix for @example paths.\n(defaults to the project root)');
205205
parser.addOption('rel-canonical-prefix',
206206
help:
207-
'If provided, add a rel="canonical" prefixed with provided value. \n'
208-
'Consider using if building many versions of the docs for public SEO. '
209-
'Learn more at https://goo.gl/gktN6F.');
207+
'If provided, add a rel="canonical" prefixed with provided value. '
208+
'Consider using if\nbuilding many versions of the docs for public '
209+
'SEO; learn more at https://goo.gl/gktN6F.');
210210
parser.addFlag('include-source',
211-
help: 'Show source code blocks', negatable: true, defaultsTo: true);
211+
help: 'Show source code blocks.', negatable: true, defaultsTo: true);
212212
parser.addOption('favicon',
213-
help: 'A path to a favicon for the generated docs');
213+
help: 'A path to a favicon for the generated docs.');
214214
parser.addFlag('use-categories',
215-
help: 'Group libraries from the same package into categories',
215+
help: 'Group libraries from the same package into categories.',
216216
negatable: false,
217217
defaultsTo: false);
218218
return parser;

0 commit comments

Comments
 (0)