Skip to content

Add a short documentation section about the io sub-package#237

Merged
aaronayres35 merged 4 commits into
masterfrom
doc/io
Nov 25, 2020
Merged

Add a short documentation section about the io sub-package#237
aaronayres35 merged 4 commits into
masterfrom
doc/io

Conversation

@aaronayres35
Copy link
Copy Markdown
Contributor

@aaronayres35 aaronayres35 commented Nov 24, 2020

fixes #53

This PR adds a brief section to the documentation discussing the apptools.io and apptools.io.h5 sub packages.

Checklist

  • Add a news fragment if this PR is news-worthy for end users. (see docs/releases/README.rst)

Comment thread docs/source/io/introduction.rst Outdated
Copy link
Copy Markdown
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

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

Thank you. Some nitpicks, the reference to zarr might be an overstatement though.

Comment thread docs/source/io/introduction.rst Outdated
Comment thread docs/source/io/introduction.rst Outdated
Comment thread docs/source/io/introduction.rst Outdated
Comment thread docs/source/io/introduction.rst Outdated
Comment thread docs/source/io/introduction.rst Outdated
Comment thread docs/source/io/introduction.rst Outdated
@@ -0,0 +1,27 @@
io
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry I did not try to build the documentation earlier.
The all-small-cap and short section title looks slightly out of place:
Screenshot 2020-11-25 at 14 39 55

Would "File I/O" look a bit better? And "io.h5" be changed to "HDF5 File support"?

Copy link
Copy Markdown
Contributor

@kitchoi kitchoi left a comment

Choose a reason for hiding this comment

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

LGTM

@aaronayres35 aaronayres35 merged commit f18ba41 into master Nov 25, 2020
@aaronayres35 aaronayres35 deleted the doc/io branch November 25, 2020 15:11
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.

io.h5 documentation apparently missing

2 participants