Better generated documentation #11
Comments
chris-morgan
added a commit
to chris-morgan/rust-typed-builder
that referenced
this issue
Mar 19, 2019
This doesn’t actually solve idanarye#11 (there are still substantial changes that should be made to the default docs for the `builder()` method), but it lets you customise how it will appear, and unhide the builder type, which are both a Good Thing™. I have written no real tests for this because the system’s not well-placed for doing that; I’ve just written tests to ensure that it at least compiles. Yet not testing the documentation generated is not good.
chris-morgan
added a commit
to chris-morgan/rust-typed-builder
that referenced
this issue
Mar 19, 2019
This doesn’t actually solve idanarye#11 (there are still substantial changes that should be made to the default docs for the `builder()` method), but it lets you customise how it will appear, and unhide the builder type, which are both a Good Thing™. I have written no real tests for this because the system’s not well-placed for doing that; I’ve just written tests to ensure that it at least compiles. Yet not testing the documentation generated is not good.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When I expose a struct with private fields to my users, they have no way to tell what types to supply. It's also a big blob of text. A bit more spacing and typed would be a big boon for library creators.
The text was updated successfully, but these errors were encountered: