Skip to content
This repository was archived by the owner on Sep 11, 2020. It is now read-only.

Improve documentation #259

Merged
merged 8 commits into from
Feb 8, 2017
Merged

Improve documentation #259

merged 8 commits into from
Feb 8, 2017

Conversation

smola
Copy link
Collaborator

@smola smola commented Feb 7, 2017

No description provided.

@smola
Copy link
Collaborator Author

smola commented Feb 7, 2017

This PR fixes #246 and partially #242

Serabe
Serabe approved these changes Feb 7, 2017
View reviewed changes
Copy link
Contributor

@Serabe Serabe left a comment

Choose a reason for hiding this comment

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

Great work!

ajnavarro
ajnavarro suggested changes Feb 8, 2017
View reviewed changes
plumbing/object/tag.go Outdated
Name string
// Tagger is the one who created the tag.
Tagger Signature
// Message is an arbitrary text message
Message string
TargetType plumbing.ObjectType
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add comments to this two properties too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

plumbing/object/tag.go
@@ -20,9 +20,13 @@ import (
//
Copy link
Contributor

Choose a reason for hiding this comment

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

Add some info about Lightweight Tags and say that this method does not return this kind, can help people that don't know this two kinds of tags.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done.

@codecov-io
Copy link

Codecov Report

Merging #259 into master will not impact coverage.

@@           Coverage Diff           @@
##           master     #259   +/-   ##
=======================================
  Coverage   76.91%   76.91%           
=======================================
  Files         108      108           
  Lines        7347     7347           
=======================================
  Hits         5651     5651           
  Misses       1106     1106           
  Partials      590      590
Impacted Files Coverage Δ
plumbing/object/blob.go 73.58% <ø> (ø) ✅
utils/ioutil/common.go 60% <ø> (ø) ✅
plumbing/object/tag.go 73.1% <ø> (ø) ✅
plumbing/object/commit.go 75.18% <ø> (ø) ✅
plumbing/object/commit_walker.go 87.09% <ø> (ø) ✅
plumbing/object/object.go 67.39% <ø> (ø) ✅
plumbing/object/tree.go 71.02% <ø> (ø) ✅
plumbing/object/file.go 76.08% <ø> (ø) ✅

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 431af32...84b6bd8. Read the comment docs.

@mcuadros mcuadros merged commit b65d94e into src-d:master Feb 8, 2017
@smola smola deleted the docs branch February 8, 2017 11:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Serabe Serabe Serabe approved these changes

@ajnavarro ajnavarro ajnavarro approved these changes

@mcuadros mcuadros Awaiting requested review from mcuadros

@alcortesm alcortesm Awaiting requested review from alcortesm

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@smola @codecov-io @Serabe @ajnavarro @mcuadros