Skip to content

Added API Docs#196

Open
srivarra wants to merge 3 commits intomainfrom
docs/add-api
Open

Added API Docs#196
srivarra wants to merge 3 commits intomainfrom
docs/add-api

Conversation

@srivarra
Copy link
Collaborator

@srivarra srivarra commented Dec 12, 2025

Added and reformatted documentation for functions across biahub.

This required some of the following changes as well:

  • Updated type hints and docstrings across the codebase:
    • Migrated Python type hints with (PEP 585): Listlist, Optional[X]X | None, etc.
    • Standardized docstrings to Numpydoc format with Parameters and Returns sections.
  • Using the root contributing.md file instead of copying the one in the docs directory.

Note: We should add Ruff rules for docstring validation in a separate PR. But that can happen after a larger Ruff (with minimal rule selections) + uv PR.

@srivarra srivarra linked an issue Dec 12, 2025 that may be closed by this pull request
@srivarra srivarra requested review from ieivanov and tayllatheodoro and removed request for ieivanov December 15, 2025 17:30
@srivarra srivarra marked this pull request as ready for review December 15, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API Documentation

1 participant