Repository navigation
Conversation
…ared The public methods merge, read, insert, remove, and shared lacked doc comments, while their neighbours (new, from_set, replace, mark_synced, is_synced, wait_synced) were all documented. The most important gap is merge: unlike replace it does not mark the allowlist as synced, which is a subtle invariant that callers must observe to avoid wait_synced timing out forever. The new doc comment calls this out explicitly and refers to mark_synced so readers know what to call after consuming the authoritative source. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
|
Thank you for your submission! We ask that you sign our Developer Certificate of Origin before we can accept your contribution. You can sign the DCO by adding a comment below using this text: I have read the DCO document and I hereby sign the DCO. You can retrigger this bot by commenting recheck in this Pull Request. Posted by the DCO Assistant Lite bot. |
|
Thank you for your interest in contributing to OpenShell, @0x5t4l1n. This project uses a vouch system for first-time contributors. Before submitting a pull request, you need to be vouched by a maintainer. To get vouched:
See CONTRIBUTING.md for details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Five public methods on
DynamicStringAllowlisthad no doc comments whileall their neighbours were fully documented:
mergereplace)readinsertmergeremovesharedThe most important gap is
merge: callers that usemergeto populate theallowlist incrementally must call
mark_syncedthemselves afterwards, orwait_synced/is_syncedwill never reporttrue. Without a doccomment this invariant is invisible.
No behaviour is changed; this is documentation only.
Test plan
cargo doc -p openshell-core --no-deps— rendered docs look correctcargo test -p openshell-core— no regressions🤖 Generated with Claude Code