Refine API-GUIDELINES recommendations #2832
Conversation
documentation/API-GUIDELINES.md
Outdated
| - `Clone/Copy` depends on the size and contents of the structure. They should generally be implemented, unless there is a good reason not to. | ||
| - The `Default` configuration needs to make sense for a particular driver, and applying the default configuration must not fail. | ||
| - Error types: `Debug/Display`, `PartialEq/Eq`, `Clone/Copy`, `Hash` | ||
| - Error types: `Debug`, `PartialEq/Eq`, `Clone/Copy`, `Hash` |
There was a problem hiding this comment.
given we raised the MSRV should we ask for core::error::Error
There was a problem hiding this comment.
Just noting that Error requires Display
There was a problem hiding this comment.
I think we should impl Error though. I have a feeling it will help with out documentation related unwrap and ok issues. We should be able to make our doc snippet main fn main() -> Result<(), alloc::Box<dyn core::error::Error>>, and from there we can hopefully ? everything.
If that required Display then I guess we found the reason to impl Display? cc: @jessebraham for your thoughts.
There was a problem hiding this comment.
If that required Display then I guess we found the reason to impl Display?
We found the reason to impl Display in this very particular case yes :D
There was a problem hiding this comment.
For errors yes it probably makes sense, that's generally pretty straight forward to implement. Still don't think it makes sense for other types though, e.g. config structs or drivers.
bugadani
changed the title
bugadani
force-pushed
the
refine-guideline
branch
from
d367b39 to
088d090
Compare
Please don't hesitate to voice your opinion if something still doesn't make sense.