search

outbrain / outrank

A Python library for efficient feature ranking and selection on sparse data sets.
https://dl.acm.org/doi/10.1145/3604915.3610636
BSD 3-Clause "New" or "Revised" License
19 stars 3 forks source link

Docs and version #38

Closed SkBlaz closed 1 year ago

SkBlaz commented 1 year ago

Updated docs + version bump + pip released.

SkBlaz commented 1 year ago

The general docs are a bit messy, every public function / method and global variable is rendered. Consider limiting this list. The pdoc documentation suggests using __all__ to limit what is public. But there are probably other mechanisms to ignore and limit the scope of documented names.

Good point, thanks @miha-jenko. Indeed, the purpose of this PR was merely to align source/signatures; perhaps we should consider refactoring of the docs themselves in a separate PR? Currently everything is searchable which was the first milestone, it can be done better for sure.