-
Notifications
You must be signed in to change notification settings - Fork 534
_examples: improve documentation (fix #238) #293
Conversation
Codecov Report
@@ Coverage Diff @@
## master #293 +/- ##
=======================================
Coverage 77.03% 77.03%
=======================================
Files 116 116
Lines 7902 7902
=======================================
Hits 6087 6087
Misses 1161 1161
Partials 654 654 Continue to review full report at Codecov.
|
_examples/push/main.go
Outdated
@@ -7,6 +7,8 @@ import ( | |||
. "srcd.works/go-git.v4/_examples" | |||
) | |||
|
|||
// Example of how to open a repository in a specific path, and do a push to | |||
// his default remote (origin). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
his
-> its
_examples/push/main.go
Outdated
@@ -7,6 +7,8 @@ import ( | |||
. "srcd.works/go-git.v4/_examples" | |||
) | |||
|
|||
// Example of how to open a repository in a specific path, and do a push to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do a push
-> push
_examples/push/main.go
Outdated
@@ -15,6 +17,7 @@ func main() { | |||
CheckIfError(err) | |||
|
|||
Info("git push") | |||
// push using default push options |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
push options
-> options
_examples/remotes/main.go
Outdated
@@ -10,6 +10,13 @@ import ( | |||
"srcd.works/go-git.v4/storage/memory" | |||
) | |||
|
|||
// Example of how to: | |||
// - Create a new repository into memory |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
repository into memoty
-> in-memory repository
_examples/remotes/main.go
Outdated
@@ -10,6 +10,13 @@ import ( | |||
"srcd.works/go-git.v4/storage/memory" | |||
) | |||
|
|||
// Example of how to: | |||
// - Create a new repository into memory | |||
// - Create a new remote called "example" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
called
-> named
_examples/remotes/main.go
Outdated
// - Create a new remote called "example" | ||
// - List remotes and print them | ||
// - Pull using the new remote "example" | ||
// - Iterate again the references, but only showing hash references, not simbolic ones |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
iterate again the references
-> iterate the refererences again
simbolic
-> symbolic
No description provided.