Fix typos in notebook #1967
Fix typos in notebook #1967
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1967 +/- ##
==========================================
- Coverage 86.19% 86.18% -0.02%
==========================================
Files 191 191
Lines 9362 9362
==========================================
- Hits 8070 8069 -1
- Misses 1292 1293 +1 |
| @@ -467,7 +467,7 @@ | |||
| "tags": [] | |||
| }, | |||
| "source": [ | |||
| "Another useful ``RasterTransformer`` is the :class:`.StatsTransformer`. \n", | |||
There was a problem hiding this comment.
This is a ReST cell. ReST uses double back ticks for inline code.
| @@ -159,7 +159,7 @@ | |||
| "id": "83a6debf-e477-4b70-b82d-8e079ef8881e", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "`RasterSource`s support `numpy`-like array slicing, so we can read a smaller chip within the full raster like so:" | |||
There was a problem hiding this comment.
The
`<class name>`s
convention is a deliberate choice. The trailing "s" is excluded from the inline code block to clarify that it is just for pluralization and not part of the class' name.
There was a problem hiding this comment.
It is inconsistent. Some places uses s, some not.
https://docs.rastervision.io/en/0.21/usage/tutorials/reading_raster_data.html
There was a problem hiding this comment.
That's true. The reason for that is a quirk of ReST/sphinx. The following is what I would like to do, but it does not work.
:class:`.RasterSource`sSo I ended up including the "s" whenever the class name is linked to the API docs.
| @@ -727,7 +727,7 @@ | |||
| "tags": [] | |||
| }, | |||
| "source": [ | |||
| "``Point`` and ``LineString`` geometries are not directly useable if doing, say, semantic segmentation. The cells below show an example of converting road geometries (given in the form of ``LineString``s) into polygons using the :class:`.BufferTransformer`." | |||
There was a problem hiding this comment.
See other comment about ReST.
| @@ -343,7 +343,7 @@ | |||
| "source": [ | |||
| ":class:`RasterSources <raster_source.raster_source.RasterSource>` accept a list of :class:`RasterTransformers <raster_transformer.raster_transformer.RasterTransformer>`, all of which are automatically applied (in the order specified) to each chip sampled from that :class:`.RasterSource`.\n", | |||
| "\n", | |||
| "Below we'll look at two such `RasterTransformer`s:\n", | |||
| "Below we'll look at two such `RasterTransformers`:\n", | |||
There was a problem hiding this comment.
This text is not currently correctly rendered because it is using single back ticks instead of double back ticks.
| "Below we'll look at two such `RasterTransformers`:\n", | |
| "Below we'll look at two such ``RasterTransformer``s:\n", |
|
I can close this PR if the fixes are unintended. No worries. I just wanted to point out the inconsistent uses of class names and ticks. Some are not rendered properly on the website. |
|
|
|
Never mind. I am closing it. |
|
Fair enough. Thanks for the PR anyway, Appreciate the effort. |
Overview
This PR fixes some typos and formatting issues in the notebook.
https://docs.rastervision.io/en/0.21/usage/tutorials/reading_raster_data.html
Checklist
needs-backportlabel if PR is bug fix that applies to previous minor releaseNotes
Optional. Ancillary topics, caveats, alternative strategies that didn't work out, anything else.
Testing Instructions
Closes #XXX