Skip to content

Conversation

@sneakers-the-rat
Copy link
Collaborator

fix: #84

refreshing the API docs. getting them into a navigable/complete state. didnt' try and make sure all the docstrings were complete, that can be something we do gradually, but this makes a reference description of the package. we should probably make another "top level API" file that's like all the stuff that can be imported from the top noob namespace, but not in this PR.

@sneakers-the-rat sneakers-the-rat added this to the docs milestone Dec 12, 2025
@sneakers-the-rat sneakers-the-rat added the documentation Improvements or additions to documentation label Dec 12, 2025
@coveralls
Copy link

coveralls commented Dec 12, 2025

Coverage Status

coverage: 85.288% (-0.02%) from 85.312%
when pulling a93ce20 on docs-api
into ab4dd8e on main.

@raymondwjang
Copy link
Collaborator

is this finished?

@raymondwjang
Copy link
Collaborator

or waiting for me to update the docs for assets

@sneakers-the-rat
Copy link
Collaborator Author

Good to go, these can all be mostly independent

@raymondwjang raymondwjang merged commit 08fe9c4 into main Dec 12, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: API Guide

4 participants