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

Changed help command output from inside the cli #4766

Merged
merged 1 commit into from
Nov 13, 2015

Conversation

aneshas
Copy link
Contributor

@aneshas aneshas commented Nov 12, 2015

Changed help command output from inside the cli to
match the info provided by the influx --help output

Added history command as suggested by @gunnaraasen

Minor edits as proposed by @beckettsean

Removed command names duplication and

Closes #4722

  • CHANGELOG.md updated
  • Rebased/mergable
  • Tests pass
  • Sign CLA (if not already signed)

Signed-off-by: Anes Hasicic anes.hasicic@gmail.com

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

Thanks @aneshas - have you signed the CLA?

@aneshas
Copy link
Contributor Author

aneshas commented Nov 12, 2015

@otoolep Yes I have

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

Thanks, CLA confirmed signed.

@gunnaraasen
Copy link
Member

This is a good cleanup but I don't think it addresses all of #4722 since there are still some recently added shell commands like history that are not listed in the shell help text.

@aneshas
Copy link
Contributor Author

aneshas commented Nov 12, 2015

@gunnaraasen You are right

@aneshas
Copy link
Contributor Author

aneshas commented Nov 12, 2015

There is also gopher command

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

That command is not meant for documentation.

@aneshas
Copy link
Contributor Author

aneshas commented Nov 12, 2015

So there is only history command left, what description do I put?

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

"Display command history" works for me, no need to be fancy.

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

The build failure is nothing to do with your change, it's something else.

a full list of influxql commands can be found at:
connect <host:port> Connect connects to another node specified by host:port
auth Auth prompts for username and password
pretty Pretty turns on pretty print for the json format
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we need to leave "toggle" in the description. Once pretty print is enabled, sending pretty again disables it.

"Pretty toggles pretty print for the json format "

@beckettsean
Copy link
Contributor

minor edits

@aneshas aneshas force-pushed the cli-help-contrib branch 2 times, most recently from fcdc2b0 to a46b773 Compare November 12, 2015 21:38
@aneshas
Copy link
Contributor Author

aneshas commented Nov 12, 2015

@beckettsean Should be done :)

show tag values show tag value information

a full list of influxql commands can be found at:
connect <host:port> Connect connects to another node specified by host:port
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure I like this format of continually repeating the command in the explanation -- it seems overly verbose. I preferred the older format.

@beckettsean

@beckettsean
Copy link
Contributor

@otoolep I'm indifferent to repeating the command. I think the canonical style is to omit the command in the -help output, but I don't think it's poor form to do it this way. It's verbose, but clear.

I would lean towards removing the duplication of the command but I wouldn't hold the PR to wait for it.

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

That's fine, I'll defer to you @beckettsean

@otoolep
Copy link
Contributor

otoolep commented Nov 12, 2015

OK, +1 from me.

+1 from you @beckettsean ?

@beckettsean
Copy link
Contributor

@gunnaraasen care to weigh in?

@gunnaraasen
Copy link
Member

I'm all for reducing verbosity but this looks good for now.

@aneshas
Copy link
Contributor Author

aneshas commented Nov 13, 2015

@beckettsean Care to elaborate, you really got me here:
this isn't a valid query, it requires with key = <tag_key>.

Let's remove it in favor of show field keys, which is valid and mirrors show tag keys.

So I need to put back show tag keys in and put show field keys instead of show tag values ?

@otoolep I will remove duplication of commands also

match the info provided by the influx --help output,
and added history command

Reverted description for pretty command

+ minor edits

Removed duplication of command names

Signed-off-by: Anes Hasicic <anes.hasicic@gmail.com>
@aneshas
Copy link
Contributor Author

aneshas commented Nov 13, 2015

ok, done @otoolep @beckettsean

@beckettsean
Copy link
Contributor

Looks good to me. Confirming the CLA has been signed.

@otoolep I can't imagine the CI failure is related, but can you confirm before I merge?

@otoolep
Copy link
Contributor

otoolep commented Nov 13, 2015

Yeah, we can ignore the failure.

otoolep added a commit that referenced this pull request Nov 13, 2015
Changed help command output from inside the cli
@otoolep otoolep merged commit 172cc43 into influxdata:master Nov 13, 2015
@otoolep
Copy link
Contributor

otoolep commented Nov 13, 2015

@aneshas -- please send me an email so we can send you a t-shirt!

@aneshas
Copy link
Contributor Author

aneshas commented Nov 13, 2015

Tnx :D @otoolep anes.hasicic@gmail.com is my e-mail

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.

4 participants