Skip to content

Remove superfluous periods from pub --help subcommand descriptions. #106925

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.

Sign up for GitHub

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

Jump to bottom
Merged
bryanoltman merged 8 commits into from
Jul 11, 2022
Merged

Remove superfluous periods from pub --help subcommand descriptions. #106925

bryanoltman merged 8 commits into from
Jul 11, 2022

Conversation

@bryanoltman
Copy link
Contributor

@bryanoltman bryanoltman commented Jul 1, 2022 •
edited
Loading

Fixes #106924

Before:

⑆ flutter pub --help
Commands for managing Flutter packages.

// Global options and usage omitted for clarity.

Available subcommands:
  add         Add a dependency to pubspec.yaml..
  cache       Work with the Pub system cache.
  deps        Print package dependencies.
  downgrade   Downgrade packages in a Flutter project.
  get         Get packages in a Flutter project.
  global      Work with Pub global packages.
  login       Log into pub.dev..
  logout      Log out of pub.dev..
  outdated    Analyze dependencies to find which ones can be upgraded.
  pub         Pass the remaining arguments to Dart's "pub" tool.
  publish     Publish the current package to pub.dartlang.org.
  remove      Removes a dependency from the current package..
  run         Run an executable from a package.
  test        Run the "test" package.
  token       Manage authentication tokens for hosted pub repositories..
  upgrade     Upgrade the current package's dependencies to latest versions..
  uploader    Manage uploaders for a package on pub.dev.
  version     Print Pub version.

Run "flutter help" to see global options.

After:

⑆ flutter pub --help
Commands for managing Flutter packages.

// Global options and usage omitted for clarity.

Available subcommands:
  add         Add a dependency to pubspec.yaml.
  cache       Work with the Pub system cache.
  deps        Print package dependencies.
  downgrade   Downgrade packages in a Flutter project.
  get         Get packages in a Flutter project.
  global      Work with Pub global packages.
  login       Log into pub.dev.
  logout      Log out of pub.dev.
  outdated    Analyze dependencies to find which ones can be upgraded.
  pub         Pass the remaining arguments to Dart's "pub" tool.
  publish     Publish the current package to pub.dartlang.org.
  remove      Removes a dependency from the current package.
  run         Run an executable from a package.
  test        Run the "test" package.
  token       Manage authentication tokens for hosted pub repositories.
  upgrade     Upgrade the current package's dependencies to latest versions.
  uploader    Manage uploaders for a package on pub.dev.
  version     Print Pub version.

Run "flutter help" to see global options.

@flutter-dashboard flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Jul 1, 2022
@flutter-dashboard
Copy link

flutter-dashboard bot commented Jul 1, 2022

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

jonahwilliams
jonahwilliams approved these changes Jul 11, 2022
View reviewed changes
Copy link
Contributor

@jonahwilliams jonahwilliams left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM nice!

@bryanoltman bryanoltman merged commit bf7df23 into flutter:master Jul 11, 2022
@bryanoltman bryanoltman deleted the pub-help-periods branch July 11, 2022 17:06
This was referenced Jul 12, 2022
Merged
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Jul 12, 2022
@engine-flutter-autoroll
bf7df23 Remove superfluous periods from pub --help subcommand descr…
fba6992 
…iptions. (flutter/flutter#106925)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 12, 2022
@engine-flutter-autoroll
bf7df23 Remove superfluous periods from pub --help subcommand descr…
8b8f21d 
…iptions. (flutter/flutter#106925)
camsim99 pushed a commit to camsim99/flutter that referenced this pull request Aug 10, 2022
@bryanoltman @camsim99
Remove superfluous periods from pub --help subcommand descriptions. (…
43f3ed6 
…flutter#106925)

* Remove periods from pub --help command descriptions

* Add trailing period consistently

* Remove added period from PackagesInteractiveGetCommand description

* Verify line ending for first line of command description

* Update _allowedTrailingPatterns to validate that lines end with only one period, bang, or colon
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 30, 2022
@engine-flutter-autoroll
bf7df23 Remove superfluous periods from pub --help subcommand descr…
f5e6981 
…iptions. (flutter/flutter#106925)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Aug 30, 2022
@engine-flutter-autoroll
bf7df23 Remove superfluous periods from pub --help subcommand descr…
eb65d85 
…iptions. (flutter/flutter#106925)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@jonahwilliams jonahwilliams jonahwilliams approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

tool Affects the "flutter" command-line tool. See also t: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Some flutter pub --help subcommand descriptions contain an extra period

2 participants

@bryanoltman @jonahwilliams