search

datamol-io / datamol

Molecular Processing Made Easy.
https://docs.datamol.io
Apache License 2.0
462 stars 48 forks source link

Documentation not up-to-date? #107

Closed DomInvivo closed 2 years ago

DomInvivo commented 2 years ago

There are some functions missing from the Datamol documentation. Such as unique_id.

Most functions are there, but do not appear in the search bar. This is due to the name not appearing in the docs, but only in the Table of Content, making it quite hard to find the right function. We can find the name of the function in the ToC on the right, or by showing the code (circled in red), but the name should appear on top of the function description. image

maclandrol commented 2 years ago

Good catch @DomInvivo.

Some function are indeed missing in the docs, and the bug around function name you are referring to has been introduced in last release I think (see https://doc.datamol.io/0.7.5/api/datamol.html for comparison) @hadim , we should revert back to the previous markdown in the docs.

hadim commented 2 years ago

Thanks guys for the catch. I am not doing great job with that API doc since it must be manually done and recent mkdocs releases and making this quite a nightmare TBH.

I usually rely on the source code itself instead of the doc.

I'll try to fix it at some point (or you are welcome to contribute xD).