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

print other parts of the doc string in detailed help info #9

Open
Roger-luo opened this issue Jul 23, 2020 · 2 comments
Open

print other parts of the doc string in detailed help info #9

Roger-luo opened this issue Jul 23, 2020 · 2 comments
Labels
display printing & display related issues

Comments

@Roger-luo
Copy link
Collaborator

currently only the required sections are displayed and parsed in the help info. We should definitely print the other parts as well, e.g if the doc string contains some sections other than Arguments, Options or Flags (like an Example section, or !!!note section etc.)

@Roger-luo Roger-luo added the display printing & display related issues label Jul 23, 2020
@kdheepak
Copy link

It would also be nice if you can take screen width into consideration:

image

Or perhaps there's an alternative format for printing the docs where it doesn't depend on screen width?

@Roger-luo
Copy link
Collaborator Author

You can turn runtime printing on, the reason why width is not taken into account is mainly for making 1.8 and lower versions happy with the latency. Now with pkgimage this is getting much better we should probably consider a refactor of some of the CLI runtime to make it richer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
display printing & display related issues
Projects
None yet
Development

No branches or pull requests

2 participants