Skip to content
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

improves lendocs #72

Merged
merged 2 commits into from
Oct 1, 2024
Merged

improves lendocs #72

merged 2 commits into from
Oct 1, 2024

Conversation

chanced
Copy link
Owner

@chanced chanced commented Sep 30, 2024

fixes #72

@chanced
Copy link
Owner Author

chanced commented Sep 30, 2024

I think this is sane. One can always do ptr.tokens().count() for the alternative definition of "length".

I see that you've copied the doc-comment from str::len. This is mostly accurate, since we do indeed just delegate to that method, but the semantics is not quite right. I think we could go with something simpler instead, along the lines of:

/// This length expresses the byte count of the underlying string that represents the RFC 6091 Pointer. See also [std::str::len].

Although the caveat with char/graphemes applies, it's less important for us than the relationship with std::str.

Originally posted by @asmello in #69 (comment)

Carry over from the above.

I guess I leave len and is_empty on PointerBuf for now, right? Ugh. I realized I had accidentally added them to PointerBuf and I thought I deleted them to move them on to Pointer but I guess I yanked them instead :(.

@chanced chanced merged commit 3e2d976 into main Oct 1, 2024
19 of 20 checks passed
@chanced
Copy link
Owner Author

chanced commented Oct 1, 2024

I yanked v06.2 - i seriously doubt it'd be a breaking change for anyone but I wanted to make sure since the CI reported it as such.

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.

1 participant