tokio-rs / axum

Ergonomic and modular web framework built with Tokio, Tower, and Hyper

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation about Key::derive_from lists wrong feature name

PuercoPop opened this issue · comments

  • 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?

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