Skip to content

Conversation

@markrahimi
Copy link

Summary

This PR addresses issue #633 by adding a new documentation section on handling missing arguments in Python Fire CLIs.

Changes

  • Added a new "Handling Missing Arguments" section to the README
  • Included a practical example showing how to use default values and docstrings
  • Explained how this improves user experience when required arguments are missing

Benefits

  • Users will get clearer error messages through better documentation
  • Provides best practices for handling required vs optional arguments
  • Makes the --help output more informative

Closes #633

Addresses google#633 by documenting best practices for handling missing
arguments with default values and clear docstrings. This helps
users create more user-friendly CLIs with better error messages.
@google-cla
Copy link

google-cla bot commented Nov 14, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve error message when required argument is missing

1 participant