docs: add C / s2n-tls-sys doc references to s2n-tls docs #5012
Conversation
This file contains 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
dougch
approved these changes
Jan 9, 2025
jmayclin
approved these changes
Jan 15, 2025
maddeleine
approved these changes
Jan 15, 2025
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.
Release Summary:
Description of changes:
Add links to the underlying C / s2n-tls-sys methods to the s2n-tls documentation. To avoid duplicating documentation, we should link to the existing docs where possible.
Putting an s2n-tls-sys method in "[]" links to the s2n-tls-sys documentation, which is generated from the C documentation. Here's an existing example: https://docs.rs/s2n-tls/latest/s2n_tls/cert_chain/struct.Builder.html
Call-outs:
The grep_simple_mistakes.sh script is not super effective at catching places we're missing the documentation, but it's better than nothing? I was playing around with writing a more serious lint, but the underlying problem is that it's not super clear where the "Corresponds" messages should be. For example, poll_recv_raw calls s2n_recv but the "Corresponds" message should go on poll_recv, which calls poll_recv_raw.
Testing:
Fairly simple doc change. I generated the docs and verified the links work as expected.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.