Repository navigation
docs(pact-ffi): publish pactffi_string_delete in the crate docs - #552
Merged
Merged
Conversation
`pactffi_string_delete` is defined in the private `util::string` module, so rustdoc omits it even though every FFI function returning a string directs callers to it. Every exported FFI function should have accessible documentation, so re-export it from the crate root and docs.rs renders it alongside the rest. Assisted-by: Claude Code:claude-opus-5[1m] Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
force-pushed
the
fix/ffi-string-delete-docs
branch
from
September 17, 2026 10:17
2a314e8 to
bf36b47
Compare
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.
pactffi_string_deleteis defined in the privateutil::stringmodule, so rustdoc omits it: there is nofn.pactffi_string_delete.htmlon docs.rs even though every FFI function returning a heap string tells callers to free it with this function. Every exported FFI function should have accessible documentation.This re-exports it from the crate root so it is documented at
pact_ffi/fn.pactffi_string_delete.html, alongside the other exported functions. Theutilmodule itself stayspub(crate). Verified locally withcargo doc -p pact_ffi --no-deps.