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

It's not clear from docs how to use the library #29

Open
lsunsi opened this issue Mar 27, 2024 · 4 comments
Open

It's not clear from docs how to use the library #29

lsunsi opened this issue Mar 27, 2024 · 4 comments

Comments

@lsunsi
Copy link
Contributor

lsunsi commented Mar 27, 2024

Maybe it's more of a 'me' problem, but from docs there's nothing being shown as exported by the library and in the Usage section there's a mention to Cargo.toml but not on how to replace the Connection.

I took the liberty of opening a PR to fix the first point.

@johnchildren
Copy link
Collaborator

Thank you for the PR, the docs are now showing the exported items: https://docs.rs/diesel-tracing/0.2.4/diesel_tracing/#modules

I was expecting the modules to be marked by the feature flags they depend on however, so I'm not sure if there's more that needs to be changed. Do you think I should try and see why this isn't happening or are they improved enough?

For the second point I can try and improve the docs a bit, would you be interested in reviewing the changes?

@lsunsi
Copy link
Contributor Author

lsunsi commented Mar 28, 2024

I also expected the same thing, for the features to be flagged. Hm, let me research some more on that.
And of course, shoot it my way. I think literally just showing an example like "replace diesel::Connection with ... " and some code would be enough, since the usage is not really that complicated!

@lsunsi
Copy link
Contributor Author

lsunsi commented Mar 28, 2024

On a library I published in the past, I can see the features (https://docs.rs/lnurlkit/latest/lnurlkit/). I'm trying to figure out what I did different.

@johnchildren
Copy link
Collaborator

And of course, shoot it my way. I think literally just showing an example like "replace diesel::Connection with ... " and some code would be enough, since the usage is not really that complicated!

Thanks, I've tried to expand a bit on the docs with this PR but I think I may make another pass at it over the long weekend. Any comments are very welcome.

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

2 participants