Documentation Mods #1
Conversation
| :alt: Diagram of the cartesian widget localisation. | ||
|
|
||
| This is a diagram of a cartesian widget showing localisation scheme. | ||
|
|
There was a problem hiding this comment.
Do we want all of this removed from the class file for a specific reason? I think it's kind of convenient to have the documentation contained in the code file so that we can see the docs along with the implementation without having to click around to different places.
There was a problem hiding this comment.
Probably right it is easier, even tough. The only reason is to be closer to all our other libraries. also this is a personal preference, I love the way the GPS documentation is done, and this is just a humble copy of that model.
Another thing also, In our library design Guidelines the concept of documentation was not present before, and at the moment we only have the section in how to use the library. https://github.com/adafruit/circuitpython/blob/main/docs/design_guide.rst.
So just want to be consistent across the libraries
| @@ -42,36 +54,36 @@ | |||
|
|
|||
|
|
|||
| class Cartesian(Widget): | |||
| """A cartesian widget. The origin is set using ``x`` and ``y``. | |||
| """A cartesian widget. The origin is set using :const:`x` and :const:`y`. | |||
There was a problem hiding this comment.
I might be misunderstanding the use of const here. Doesn't const imply that these values cannot be changed?
But it is possible for these to change isn't it? Changing x and y allows user to move the cartesian to a different location on the screen.
There was a problem hiding this comment.
Right, right, I will change it to attribute.
|
@FoamyGuy Just heads up Ill close this PR. I can hardly remember the context of the discussion. we can revisit in the future if needed. Thanks :) |
Current PR to improve documentation prestenation and add a new page to the API, to show library detailed information