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

Render docs with features enabled #4641

Open
Mark-Simulacrum opened this issue Jul 3, 2024 · 1 comment
Open

Render docs with features enabled #4641

Mark-Simulacrum opened this issue Jul 3, 2024 · 1 comment

Comments

@Mark-Simulacrum
Copy link
Contributor

Problem:

docs.rs doesn't show the available functionality gated behind features (e.g. QUIC methods).

Solution:

We should leverage the docs.rs metadata (docs: https://docs.rs/about/metadata) to enable relevant features in the public documentation. Ideally, the cfg'd methods would also use doc(cfg(...)) (rust-lang/rust#43781), so that the rendered docs make clear in a readable fashion what features need to be enabled. That feature is still unstable but docs.rs uses nightly compilers so that's not a problem.

  • Does this change what S2N sends over the wire? No
  • Does this change any public APIs? No
  • Which versions of TLS will this impact? n/a
@Mark-Simulacrum
Copy link
Contributor Author

cc aws/s2n-quic#1564, which is a related issue for s2n-quic

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants