Skip to content

Fix documentation warnings.#861

Merged
MrSkwiggs merged 1 commit intotwostraws:mainfrom
brokaw:docs
Feb 4, 2026
Merged

Fix documentation warnings.#861
MrSkwiggs merged 1 commit intotwostraws:mainfrom
brokaw:docs

Conversation

@brokaw
Copy link
Copy Markdown
Contributor

@brokaw brokaw commented Jan 28, 2026

This PR addresses all warnings when building documentation.

API is unchanged. This PR only changes to doc strings. Most changes update the documented parameters to match the defined parameters.

@wti
Copy link
Copy Markdown
Contributor

wti commented Feb 3, 2026

Test failure looks like the same false negative as #858

Copy link
Copy Markdown
Collaborator

@MrSkwiggs MrSkwiggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting this! Please rebase from main so we can double-check all tests pass, then I'll merge this 👍

Changes to doc strings only. Most changes update the documented parameters to match the defined parameters.
@MrSkwiggs
Copy link
Copy Markdown
Collaborator

Looking good, merging now, thanks!

@MrSkwiggs MrSkwiggs merged commit 735f656 into twostraws:main Feb 4, 2026
1 check passed
@brokaw brokaw deleted the docs branch February 4, 2026 15:28
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.

3 participants