search

cetz-package / docs

Documentation for CeTZ
https://cetz-package.github.io/docs/
Apache License 2.0
1 stars 4 forks source link

Improving the `plot` section #2

Closed tapyu closed 3 months ago

tapyu commented 4 months ago

Hi, I really want to contribute the plot section, but it seems really confusing how you want to organize the section. I want to add parameters such as x-tick-step, x-ticks, x-min, y-min, ... from the plot.plot() function, but I am not sure where it goes....

fenjalien commented 3 months ago

Hi! That part of the docs is intended to be more tutorial focused, a description of how to use CeTZ. We're planning on adding an API/reference section that goes into the specifics of what exists in CeTZ, it'll use the doc strings in the source code.

For the format of the section itself, we don't have any ideas so do what feels right! Once you make the pr we can suggest changes and give feedback :)

tapyu commented 3 months ago

So it is not a point-by-point explanation each parameter (e.g., x-tick-step, x-ticks, x-min, y-min) does, right?

Yes, I just saw that, for this, CeTz already has a manual. I highly suggest to add this manual in the CeTz's homepage. Maybe a Manual button in addition to the other two. Moreover, the link to this documentation, https://cetz-package.github.io/docs/overview.html, is broken. It should be https://cetz-package.github.io/docs/

For the format of the section itself, we don't have any ideas so do what feels right!

I see, okay!