Skip to content

docs: clarify how Fire behaves when called on a class #648

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

Open
HemanthGowdaHM wants to merge 1 commit into
base: master
Choose a base branch
from
+5 −0
Open

docs: clarify how Fire behaves when called on a class #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ python calculator.py double 10 # 20
python calculator.py double --number=15 # 30
```

When `Fire` is called on a class, it automatically creates an instance of that
class. The class's methods then become available as subcommands on the CLI.
For example, running `python calculator.py double 10` calls the `double`
method on a new `Calculator` instance.

To learn how Fire behaves on functions, objects, dicts, lists, etc, and to learn
about Fire's other features, see the [Using a Fire CLI page](docs/using-cli.md).

Expand Down