Skip to content

Conversation

@logan-markewich
Copy link
Collaborator

Huge overhaul to both the

  • docstrings
  • generated API reference

Now we have examples, things say the errors they raise, docstrings detail parameters, and tons of cross-linking. I think overall this makes it easier for anyone (including LLMs) to crawl our docs

@coveralls
Copy link

Pull Request Test Coverage Report for Build 16869960683

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • 1 unchanged line in 1 file lost coverage.
  • Overall coverage decreased (-0.02%) to 96.17%

Files with Coverage Reduction New Missed Lines %
src/workflows/handler.py 1 97.22%
Totals Coverage Status
Change from base Build 16834206920: -0.02%
Covered Lines: 1155
Relevant Lines: 1201

💛 - Coveralls

@logan-markewich logan-markewich merged commit 4bd97e8 into main Aug 11, 2025
6 checks passed
@logan-markewich logan-markewich deleted the logan/docstrings branch August 11, 2025 18:02
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.

4 participants