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

gz.in: sort list of commands alphabetically #134

Merged
merged 1 commit into from
Feb 28, 2024
Merged

Conversation

scpeters
Copy link
Member

🦟 Bug fix

Improves usability of gz tool

Summary

Currently the order of commands listed when running gz or gz help is a bit random, for example:

List of available commands:

  help:          Print this help text.
  plugin:        Print information about plugins.
  sdf:           Utilities for SDF files.
  gui:           Launch graphical interfaces.
  fuel:          Manage simulation resources.
  launch:        Run and manage executables and plugins.
  model:         Print information about models.
  sim:           Run and manage the Gazebo Simulator.
  param:         List, get or set parameters.
  gazebo:        Deprecated. Alias for sim.
  topic:         Print information about topics.
  service:       Print information about services.
  log:           Record or playback topics.
  msg:           Print information about messages.

Note that the help command is always listed first, but I've added some alphabetization of the non-help commands in this pull request:

List of available commands:

  help:          Print this help text.
  fuel:          Manage simulation resources.
  gazebo:        Deprecated. Alias for sim.
  gui:           Launch graphical interfaces.
  launch:        Run and manage executables and plugins.
  log:           Record or playback topics.
  model:         Print information about models.
  msg:           Print information about messages.
  param:         List, get or set parameters.
  plugin:        Print information about plugins.
  sdf:           Utilities for SDF files.
  service:       Print information about services.
  sim:           Run and manage the Gazebo Simulator.
  topic:         Print information about topics.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@github-actions github-actions bot added 🌱 garden Ignition Garden 🎵 harmonic Gazebo Harmonic 🏛️ ionic Gazebo Ionic labels Feb 28, 2024
@scpeters scpeters merged commit 0503f89 into gz-tools2 Feb 28, 2024
11 checks passed
@scpeters scpeters deleted the scpeters/alpha_cmds branch February 28, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden 🎵 harmonic Gazebo Harmonic 🏛️ ionic Gazebo Ionic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants