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 CLI docs #367

Merged
merged 1 commit into from
May 22, 2024
Merged

Improve CLI docs #367

merged 1 commit into from
May 22, 2024

Conversation

dstansby
Copy link
Contributor

  • Use bash highlighting
  • Break up code blocks so it's easier to copy/paste commands
  • Remove leading $ so it's easier to copy/paste commands

Copy link
Member

@will-moore will-moore left a comment

Choose a reason for hiding this comment

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


download
========

To download all the resolutions and metadata for an image::

# creates local 6001240.zarr/
Copy link
Member

Choose a reason for hiding this comment

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

I think this line is still useful to keep, maybe add to the sentence above?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍 done

Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

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

Sphinx is failing with:

/home/docs/checkouts/readthedocs.org/user_builds/ome-zarr/checkouts/367/docs/source/cli.rst:38: WARNING: Inline literal start-string without end-string.

see https://beta.readthedocs.org/projects/ome-zarr/builds/24167312/

@dstansby
Copy link
Contributor Author

👍 should be fixed now

@dstansby dstansby requested a review from joshmoore May 20, 2024 15:46
@joshmoore joshmoore merged commit 67c4cbb into ome:master May 22, 2024
17 of 20 checks passed
Copy link
Member

@will-moore will-moore left a comment

Choose a reason for hiding this comment

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

LGTM: thanks!

@dstansby dstansby deleted the cli-docs branch May 22, 2024 09:04
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.

None yet

3 participants