Mention a required feature in axum doc#256
Merged
jplatte merged 1 commit intotamasfe:masterfrom Oct 30, 2025
Merged
Conversation
mtizim
changed the title
jplatte
reviewed
Oct 29, 2025
Collaborator
jplatte
left a comment
jplatte
left a comment
There was a problem hiding this comment.
Hey, thanks for the PR! I agree this should be documented. However, I think it makes more sense to mention this required feature earlier, as it is already required for the snippet above. How about adding a parenthesis to line 13? Like this:
//! Take the following `axum` example (requires aide's `axum-json` feature):
mtizim
force-pushed
the
axum-json-example-doc
branch
from
b710f26 to
a2355cf
Compare
Contributor
Author
|
Makes sense, changed |
alexmohr
pushed a commit
to alexmohr/aide
that referenced
this pull request
Nov 14, 2025
alexmohr
pushed a commit
to alexmohr/aide
that referenced
this pull request
Nov 17, 2025
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
2 participants
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.
#255
Might be obvious to the devs of this crate, but it took me a stupidly long time - I assumed that copy-pasting from the example page from the
axumfeature would be enough, and the error message you get if you do not enableaxum-jsonis rather gnarly.