Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use the terminal width for the line length #2333

Merged
merged 1 commit into from
Sep 4, 2020

Conversation

devoncarew
Copy link
Member

@devoncarew devoncarew commented Sep 4, 2020

  • use the terminal width for the line length
  • fix a typo in the help options

The previous line length had been 80 chars, which made for a vary narrow column of text. Here's the before:

Generate HTML documentation for Dart libraries.

    --[no-]allow-tools                            Execute user-defined tools to
                                                  fill in @tool directives.
    --ambiguous-reexport-scorer-min-confidence    Minimum scorer confidence to
                                                  suppress warning on ambiguous
                                                  reexport.
                                                  (defaults to "0.1")
    --[no-]auto-include-dependencies              Include all the used libraries
                                                  into the docs, even the ones
                                                  not in the current package or
                                                  "include-external"
    --category-order                              A list of categories (not
                                                  package names) to place first
                                                  when grouping symbols on
                                                  dartdoc's sidebar. Unmentioned
                                                  categories are sorted after
                                                  these.
    --example-path-prefix                         Prefix for @example paths.
                                                  (defaults to the project root)
    --exclude                                     Library names to ignore.
    --exclude-packages                            Package names to ignore.
    --include                                     Library names to generate docs
                                                  for.
    --include-external                            Additional (external) dart
                                                  files to include; use
                                                  "dir/fileName", as in
                                                  lib/material.dart.
    --[no-]include-source                         Show source code blocks.
                                                  (defaults to on)
    --inject-html                                 Allow the use of the
                                                  {@inject-html} directive to
                                                  inject raw HTML into dartdoc
                                                  output.
    --input                                       Path to source directory
                                                  (defaults to
                                                  "/Users/devoncarew/projects/da
                                                  rt-lang/dartdoc")
    --link-to-hosted                              Specify URLs for hosted pub
                                                  packages
                                                  (defaults to
                                                  "pub.dartlang.org::https://pub
                                                  .dev/documentation/%n%/%v%")
    --link-to-sdks                                Specify URLs for SDKs.
                                                  (defaults to
                                                  "Dart::https://api.dart.dev/%b
                                                  %/%v%",
                                                  "Flutter::https://api.flutter.
                                                  dev/flutter")
    --[no-]link-to-remote                         Allow links to be generated
                                                  for packages outside this one.
                                                  (defaults to on)
    --output                                      Path to output directory.
                                                  (defaults to "doc/api")
    --package-order                               A list of package names to
                                                  place first when grouping
                                                  libraries in packages.
                                                  Unmentioned packages are
                                                  sorted after these.
...

@googlebot googlebot added the cla: yes Google CLA check succeeded. label Sep 4, 2020
@devoncarew devoncarew requested a review from srawlins September 4, 2020 04:19
@devoncarew devoncarew merged commit f6d6f5e into dart-lang:master Sep 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Google CLA check succeeded.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants