Fix example code formatting for CachingFileManager #9178
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
|
Thanks @djhoese ! (We seem to have some bad errors as numpy upgraded, but nothing to do with this change, so will merge...) |
Contributor
Author
|
Thanks! Good luck with the numpy 2 fixes. I'm doing something similar on my own projects. |
dcherian
added a commit
to dcherian/xarray
that referenced
this pull request
Jun 28, 2024
* main: promote floating-point numeric datetimes to 64-bit before decoding (pydata#9182) also pin `numpy` in the all-but-dask CI (pydata#9184) temporarily remove `pydap` from CI (pydata#9183) temporarily pin `numpy<2` (pydata#9181) Change np.core.defchararray to np.char (pydata#9165) (pydata#9166) Fix example code formatting for CachingFileManager (pydata#9178) Slightly improve DataTree repr (pydata#9064) switch to unit `"D"` (pydata#9170) Docs: Add page with figure for navigating help resources (pydata#9147) Add test for pydata#9155 (pydata#9161) Remove mypy exclusions for a couple more libraries (pydata#9160) Include numbagg in type checks (pydata#9159) Improve zarr chunks docs (pydata#9140)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While reading through the docs I noticed that the code examples for the CachingFileManager were all one block of text and not respecting the newlines in the source. This PR changes
:to::to tell restruturedtext/sphinx that the code blocks are literal blocks and not new paragraphs. Alternatively I could do.. code-block:: python, but I feel like that hurts readability of the source, but it may be needed if sphinx doesn't format the literal block as python code (syntax highlighting).There may be other parts of the API docs like this, but this was the first one I saw and I didn't look very hard otherwise.
whats-new.rstapi.rst