Rust: add docs for rust #10
Conversation
|
😍 😍 😍 |
|
@tasn This should be ready for review now |
There was a problem hiding this comment.
I had a quick look and everything looks great. I haven't tested it locally yet, though I assume it compiles and renders correctly (I'll do it before merging).
I only have one tiny comment that I'm happy to fix myself, and one question:
Should we wait until etesync/etebase-rs#13 is merged (and this adjusted accordingly), or would you rather have it in two steps?
Thanks a lot! I'm so happy to have this!
docs/installation.md
Outdated
|
|
||
| ```toml | ||
| [dependencies] | ||
| etebase="..." |
There was a problem hiding this comment.
Could you maybe add a comment that people should set the version and show an example? I know that Rust people will most likely already know that, but I think it will be more "noob-proof". What do you think?
There was a problem hiding this comment.
Sure, I didn't want to add a version as it's likely to get out of date soon.
Adding it as comment should be fine and we could also add the crates.io badge to the description before the code block
There was a problem hiding this comment.
That's a really good idea! After we merge this I'll do it for all the rest of the libraries!
Maybe say something like use the version from above (needs better wording), for example: "^0.4.1" so people know to use ^? I'd rather they don't pin too harshly so that they get bugfixes.
|
I'd merge this as is now (with the change you requested) and adjust it later, as I have some more input regarding the rust api based on the docs. Should I open an issue with my proposals in the https://github.com/etesync/etebase-rs repository or should I comment in this PR here in the codeblocks where I think the api could be improved for the user? |
|
OK, so I'll wait for your change and merge it. Comments on the Rust API: open an issue in that repo, that would be better. Thanks! |
|
Great, thanks a lot! |
WIP PR so that everyone knows I'm working on this 😊 will finish it the next few days
Ready: closes etesync/etebase-rs#12