Skip to content

Fix docs #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix docs #96

wants to merge 4 commits into from

Conversation

T0mstone
Copy link
Collaborator

@T0mstone T0mstone commented Jul 3, 2025

These were slightly out of date after #92.

I've also taken the liberty to rephrase them a bit; Ever since #46, the crate-level docs have explained what a variant is, so we can just use that word in the functions' docs.

(Not sure whether this counts as meta or not)

T0mstone added 2 commits July 3, 2025 23:50
The only change is "single character" -> "string",
it's just obscured by having to re-wrap the text.
@MDLC01
Copy link
Collaborator

MDLC01 commented Jul 3, 2025

I'd say this is meta but doesn't require Laurenz's approval since this is a minor documentation change.

@MDLC01 MDLC01 added the meta Discussion about the structure of this repo label Jul 3, 2025
@T0mstone
Copy link
Collaborator Author

T0mstone commented Jul 3, 2025

Found another small oversight that I've just lumped in this PR. Technically not documentation, but an assertion error message is close enough imo.

mkorje
mkorje previously approved these changes Jul 4, 2025
@mkorje mkorje dismissed their stale review July 4, 2025 00:16

Comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Discussion about the structure of this repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants