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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rust: add docs for rust #10

Merged
merged 2 commits into from Dec 5, 2020
Merged

Rust: add docs for rust #10

merged 2 commits into from Dec 5, 2020

Conversation

geovie
Copy link
Contributor

@geovie geovie commented Dec 2, 2020

WIP PR so that everyone knows I'm working on this 馃槉 will finish it the next few days

Ready: closes etesync/etebase-rs#12

@geovie geovie marked this pull request as draft December 2, 2020 20:31
@tasn
Copy link
Member

tasn commented Dec 3, 2020

馃槏 馃槏 馃槏
Looking forward to this, thanks a lot!

@geovie geovie marked this pull request as ready for review December 4, 2020 21:20
@geovie
Copy link
Contributor Author

geovie commented Dec 4, 2020

@tasn This should be ready for review now

Copy link
Member

@tasn tasn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!


```toml
[dependencies]
etebase="..."
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 crates.io to the description before the code block

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@geovie
Copy link
Contributor Author

geovie commented Dec 5, 2020

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?

@tasn
Copy link
Member

tasn commented Dec 5, 2020

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!

@tasn tasn merged commit bf87b99 into etesync:master Dec 5, 2020
@tasn
Copy link
Member

tasn commented Dec 5, 2020

Great, thanks a lot!

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

Successfully merging this pull request may close these issues.

Add usage guides to docs.etebase.com
2 participants