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

Documentation about Key::derive_from lists wrong feature name #2646

Open
1 task done
PuercoPop opened this issue Mar 13, 2024 · 1 comment
Open
1 task done

Documentation about Key::derive_from lists wrong feature name #2646

PuercoPop opened this issue Mar 13, 2024 · 1 comment
Labels
A-axum-extra C-bug Category: This is a bug. S-blocked Status: marked as blocked ❌ on something else such as a PR or other implementation work. T-docs Topic: documentation

Comments

@PuercoPop
Copy link

  • I have looked for existing issues (including closed) about this

Bug Report

Version

Latest

Platform

N/A but I'm on Linux

Crates

axum-extra

Description

The documentation for Key::derive_from (
https://docs.rs/axum-extra/latest/axum_extra/extract/cookie/struct.Key.html#method.derive_from) says its gated behind the feature key-expansion. It should be cookie-key-expansion instead. fwict this code is reexported from the cookie crate. However in the process of reexporting the code axum_extra modifies the name of the feature flag, adding the cookie- prefix. This is not reflected in the documentation, which lists key-expansion as the feature to enable. I'm not sure if there is something we can do to make sure the docs are updating when re-exporting the method or is this a limitation of docs.rs?

@jplatte
Copy link
Member

jplatte commented Mar 13, 2024

I'm pretty sure this is a rustdoc limitation that we can't do anything about.

@jplatte jplatte added C-bug Category: This is a bug. S-blocked Status: marked as blocked ❌ on something else such as a PR or other implementation work. T-docs Topic: documentation A-axum-extra labels Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-axum-extra C-bug Category: This is a bug. S-blocked Status: marked as blocked ❌ on something else such as a PR or other implementation work. T-docs Topic: documentation
Projects
None yet
Development

No branches or pull requests

2 participants