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

Extend and improve documentation on subcommands (#890) #1187

Merged
merged 1 commit into from
Sep 27, 2020
Merged

Extend and improve documentation on subcommands (#890) #1187

merged 1 commit into from
Sep 27, 2020

Conversation

deining
Copy link
Contributor

@deining deining commented Sep 25, 2020

In an order to eventually close #890, I authored this PR, I hope you like it.
Feel free to perform some polishment like you did before.

@codecov-commenter
Copy link

codecov-commenter commented Sep 25, 2020

Codecov Report

❗ No coverage uploaded for pull request base (master@0003630). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #1187   +/-   ##
=========================================
  Coverage          ?   94.30%           
  Complexity        ?      455           
=========================================
  Files             ?        2           
  Lines             ?     6673           
  Branches          ?     1793           
=========================================
  Hits              ?     6293           
  Misses            ?      102           
  Partials          ?      278           
Impacted Files Coverage Δ Complexity Δ
src/main/java/picocli/AutoComplete.java 97.01% <0.00%> (ø) 141.00% <0.00%> (?%)
src/main/java/picocli/CommandLine.java 94.14% <0.00%> (ø) 314.00% <0.00%> (?%)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0003630...3a5c4f4. Read the comment docs.

@remkop
Copy link
Owner

remkop commented Sep 26, 2020

Thank you for the contribution again!
I plan to merge this soon, I have some other commitments I need to take care of first.

@remkop remkop added this to the 4.6 milestone Sep 26, 2020
@remkop remkop merged commit f30b61f into remkop:master Sep 27, 2020
@remkop
Copy link
Owner

remkop commented Sep 27, 2020

Merged. Thank you for the contribution!
I am also rewriting and rearranging some of the other subsections of the Subcommands section.

About the new Quick Guide example:

The ISOCodeResolver application has two subcommands, language and country, that may be used to either resolve either languages or country codes following the ISO standard.

Can you clarify (ideally with links) which ISO standard(s) this refers to?

@remkop
Copy link
Owner

remkop commented Sep 27, 2020

Ah sorry, I found that the code example references the exact ISOs. Got it.

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

Successfully merging this pull request may close these issues.

Manual/Quick guide: better support for first time users
3 participants