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

Opt-out of processing rustdoc comments #166

Open
itegulov opened this issue Aug 3, 2022 · 0 comments
Open

Opt-out of processing rustdoc comments #166

itegulov opened this issue Aug 3, 2022 · 0 comments

Comments

@itegulov
Copy link

itegulov commented Aug 3, 2022

Thanks for the amazing library!

I know that there is a way to override docs on each individual struct field like this:

#[derive(JsonSchema)]
pub struct OverrideDocs {

    /// This comment will not be used as the description
    #[schemars(description = "This is the description!")]
    pub my_int: i32,

    /// This field will have no description set
    #[schemars(description = "")]
    pub my_undocumented_bool: bool,
}

But for my use case, it would be awesome if I could opt-out of processing rustdoc comments globally by enabling/disabling an option in SchemaSettings as was mentioned in #13 (comment).

If you are open to including such a feature, I would love to prepare a PR.

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

No branches or pull requests

1 participant