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

siva: add package documentation #18

Merged
merged 2 commits into from
Feb 25, 2019
Merged

siva: add package documentation #18

merged 2 commits into from
Feb 25, 2019

Conversation

jfontan
Copy link
Owner

@jfontan jfontan commented Feb 25, 2019

Fixes src-d#5

Signed-off-by: Javi Fontan <jfontan@gmail.com>
@codecov-io
Copy link

codecov-io commented Feb 25, 2019

Codecov Report

Merging #18 into siva will increase coverage by 0.86%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##            siva      #18      +/-   ##
=========================================
+ Coverage   68.5%   69.36%   +0.86%     
=========================================
  Files         13       13              
  Lines        800      829      +29     
=========================================
+ Hits         548      575      +27     
- Misses       183      186       +3     
+ Partials      69       68       -1
Impacted Files Coverage Δ
siva/repository.go 87.8% <0%> (-0.88%) ⬇️
siva/location.go 72.14% <0%> (+1.42%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 581436f...49ab543. Read the comment docs.

Copy link
Collaborator

@mcarmonaa mcarmonaa left a comment

Choose a reason for hiding this comment

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

Not really important, but maybe we should mention that errors are not being handled in the examples.

Other than that, LGTM!

Signed-off-by: Javi Fontan <jfontan@gmail.com>
@jfontan
Copy link
Owner Author

jfontan commented Feb 25, 2019

@mcarmonaa, I believe the examples are OK. It's more pseudo code than anything else. We can add some compilable examples at some point but not in overview.

@jfontan jfontan merged commit e72783d into siva Feb 25, 2019
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.

3 participants