twosigma / twosigma/marbles

Make API Reference page tell me something I want to know

Open
#98 0 comments 0 reactions 0 assignees View on GitHub
docs
Dominant language
Python
Stars
155
Forks
22
PR merge metrics
No merged PRs in 30d

Description

Linking yourself through this page is sort of the fastest way to the docstrings, but it's kind of a stark thing to land on. We should put some text here that welcomes the reader and points them to the right next thing to click: https://marbles.readthedocs.io/en/stable/reference.html

Also, maybe the module docstring summaries, maybe also go one level deeper on the toctree?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.