pendulum icon indicating copy to clipboard operation
pendulum copied to clipboard

Provide table of contents in pendulum documentation

Open Jari27 opened this issue 1 year ago • 2 comments

  • [x] I have searched the issues of this repo and believe that this is not a duplicate.

Issue

The official pendulum documentation is hard to read, hard to search and does not provide a list of functions that can be used. It's more a 'user guide' than official api reference.

The least we we can do to support people using pendulum is to provide a table of contents to the docs, so that people can guess what section they need to read.

Jari27 avatar Sep 07 '23 11:09 Jari27

It already has a ToC, which may be not very noticeable. 截屏2023-09-19 17 07 25

xzmeng avatar Sep 19 '23 09:09 xzmeng

I agree that an API reference would be very useful.

xzmeng avatar Sep 19 '23 09:09 xzmeng