docs: add missing pub API doc comments for zeph-common, zeph-db, zeph-context#4541
Merged
Conversation
github-actions
Bot
added
documentation
…text methods - Secret::new: add /// doc comment with security note on zeroization + example - Secret::expose: add /// doc comment explaining bounded lifetime and zeroization semantics - sanitize_fts_query (PostgreSQL variant): add /// doc comment (mirrors SQLite variant) - ContextBudget::allocate_with_opts: expand doc with parameters, return value, and example - ContextManager::compaction_tier: add comprehensive doc with behavior explanation and example - remove_tool_responses_middle_out: expand doc with parameters, behavior, and text example Addresses #4509 (zeph-db), #4510 (zeph-common), #4512 (zeph-context).
bug-ops
force-pushed
the
4509-4510-4512-doc-comments
branch
from
549fe1f to
c33ad04
Compare
github-actions
Bot
added
documentation
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
1 participant
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
///doc comments and#[must_use]toSecret::newandSecret::exposeinzeph-commonwith security notes and runnable examples///doc comment and#[must_use]to the PostgreSQL variant ofsanitize_fts_queryinzeph-dbto match the SQLite variant///doc comments to three undocumented public functions inzeph-context:allocate_with_opts,compaction_tier, andremove_tool_responses_middle_outTest plan
cargo +nightly fmt --check— passcargo clippy --workspace -- -D warnings— passcargo nextest run --workspace --lib --bins— 10113 passedcargo test --doc -p zeph-common -p zeph-db -p zeph-context— all doc-tests passRUSTDOCFLAGS="--deny rustdoc::broken_intra_doc_links" cargo doc --no-deps -p zeph-common -p zeph-db -p zeph-context— zero broken linksRUSTFLAGS="-D warnings" cargo check --workspace --all-targets --features desktop,ide,server,chat,pdf,scheduler --locked— passCloses #4509
Closes #4510
Closes #4512