GithubHelp home page GithubHelp logo

Comments (3)

jonasbb avatar jonasbb commented on June 9, 2024

This is a recurring problem, but I am not aware how to build diagnostics into the macro or about the documentation. It is already mentioned in the README, on the first page of the crate documentation, in the #[serde_as] documentation, and in user guide under "Switching from serde’s with to serde_as".

Maybe these existing places can be improved. I am happy to hear feedback about them. I don't think explaining the Rust macro system belongs into the documentation for the DisplayFromStr type. Like this, every conversion type would need to duplicate this documentation.

from serde_with.

FlareFlo avatar FlareFlo commented on June 9, 2024

This is a recurring problem, but I am not aware how to build diagnostics into the macro or about the documentation. It is already mentioned in the README, on the first page of the crate documentation, in the #[serde_as] documentation, and in user guide under "Switching from serde’s with to serde_as".

Maybe these existing places can be improved. I am happy to hear feedback about them. I don't think explaining the Rust macro system belongs into the documentation for the DisplayFromStr type. Like this, every conversion type would need to duplicate this documentation.

I unfortunately directly jumped to the docs for DisplayFromStr, as i was recommended serde_as by a friend and did not consider such caveats as a possibility.

from serde_with.

jonasbb avatar jonasbb commented on June 9, 2024

Since there is nothing action actionable right now, I close this. If you have suggestions on how to improve the existing places in the documentation, please let me know.

from serde_with.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.