Add module doc string for chaco.api#649
Conversation
| - :class:`~.ContourPolyPlot` | ||
| - :class:`~.LinePlot` | ||
| - :class:`~.ColormappedScatterPlot` | ||
| - :class:`~.ColormappedSelectionOverlay` |
There was a problem hiding this comment.
ColormappedSelectionOverlay seems more like a visual component
| - :class:`~.MultiLinePlot` | ||
| - :class:`~.JitterPlot` | ||
| - :class:`~.VariableSizeScatterPlot` | ||
| - :class:`~.BandedMapper` |
There was a problem hiding this comment.
BandedMapper should be moved to mappers
rahulporuri
left a comment
There was a problem hiding this comment.
LGTM. I think this is a good start. We can merge this as-is for now and revisit this later.
| Colormaps and Color Palettes | ||
| ---------------------------- | ||
|
|
||
| - |
There was a problem hiding this comment.
I was actually thinking of making the * imports from chaco.default_colormaps and chaco.default_colors explicit. It will crowd the api module (and the module docstring) but I think it's better than users having to dig through the source code to find what the available color maps are.
And we can move it to the end of the module (and the module docstring) to maintain readability.
There was a problem hiding this comment.
That makes sense. I will merge this PR and do that in a follow up PR shortly
|
CI is failing on windows/pyqt. This is the test that was just added in #636. I am not sure why this failure wasn't seen on that PR? |
This PR adds a doc string to the api module so that the objects show up in the autogenerated api docs for the api module.
Note, I followed the same grouping as already existed in the api (to keep the diff simple), but we way want to do some shuffling / reorg. For example,
BandedMapperis not currently in the "Mappers" section. I can make these changes here if preferred, or leave them to a follow up PR.Additionally, I am not sure what to do about the "Colormaps and Color Palettes" section (hence it being empty for now), as there are ~80 color maps. Suggestions are very welcome. In that sense this PR is not entirely complete, but I am flagging it as ready for review because I am no longer working on it. We will want to address this before it is merged though.