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

Improve help messages #46

Open
dominikl opened this issue Oct 6, 2020 · 4 comments
Open

Improve help messages #46

dominikl opened this issue Oct 6, 2020 · 4 comments

Comments

@dominikl
Copy link
Member

dominikl commented Oct 6, 2020

It looks like omero render info actually creates rendering settings in case there aren't any. And omero render test --thumb creates the thumbnails in case there aren't any. But this isn't stated anywhere in the help messages.

@will-moore
Copy link
Member

I would also like to see the contents of the help message in the docs on the README, so that you can read them without having to run the plugin.

@jburel
Copy link
Member

jburel commented Oct 12, 2020

@will-moore adding that comment to my doc review

@jburel
Copy link
Member

jburel commented Oct 12, 2020

some doc pages have followed that approach but not all e.g. https://docs.openmicroscopy.org/users/cli/import.html

@joshmoore
Copy link
Member

It requires some twists & turns with the build order, but at least in sphinx, I've had success with https://pypi.org/project/sphinxcontrib-programoutput/

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

4 participants