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

Documentation enhancement #33

Closed
mbierman opened this issue May 10, 2021 · 3 comments
Closed

Documentation enhancement #33

mbierman opened this issue May 10, 2021 · 3 comments

Comments

@mbierman
Copy link

The documentation is unclear.

How to get Json output?
ipinfo -j myip doesn't work.

How to get one field?
ipinfo -f City myip doesn't work.

@mbierman mbierman changed the title Documentation Documentation enhancement May 10, 2021
@UmanShahzad
Copy link
Contributor

@mbierman The flags need to come after the subcommand, which is documented in the usage string:

$ ipinfo
# notice the optional <opts> coming after <cmd>
Usage: ipinfo <cmd> [<opts>] [<args>]

...

So it'd be ipinfo myip -j.

For the field, it should be lowercase to match the JSON output, so it'd be ipinfo myip -f city. I can add a feature to force lowercase it but that might break in case we have a field that has some uppercase letters, like exampleField.

@mbierman
Copy link
Author

mbierman commented May 10, 2021

I think it is fine to leave the capitalization as it is. That seems like what I would expect.

It would be great if you could beef up the documentation a little to explain the flags and subcommands though.

@UmanShahzad
Copy link
Contributor

#13 is meant to help with that indeed.

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

No branches or pull requests

2 participants