-
Notifications
You must be signed in to change notification settings - Fork 23
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
Update documentation #69
base: master
Are you sure you want to change the base?
Conversation
@matejklemen this is super useful! There's no need for separate PRs 🙂. |
And don't worry about failed circleci jobs. This is a result of secrets not being copied to forked projects 👍. |
@matejklemen let me know when this is not WIP anymore and I will review it then. |
a883e46
to
28956ee
Compare
28956ee
to
33955c5
Compare
33955c5
to
47503a2
Compare
* make sure examples in docs are working after rebase * make examples complete by including imports
@inejc Right, I think this is ready for a review. I didn't manage to finish the docs for all packages, but I think we should try merging this before I continue (or somebody else does) writing docs in another PR. Mostly in hopes that we keep the documentation style consistent, but also because it's getting a bit tedious to do rebasing 😄 After rebasing, I verified/changed examples so that they are working and also I've added all the required imports to examples as I think that examples that work out of the box are much more useful than saving a few lines by skipping imports. |
@matejklemen I completely agree with merging this, I will give it a quick look this week 👍. |
Description of Changes
I saw the issue about getting the scaladocs out (#43) and I thought I'd update the docs a bit first. Mostly added single-sentence descriptions and some examples of use.
Might take a look at and update the other packages as well, should I continue in this PR or open a new PR per package?
Includes