From 305f28004ecbc03ea353437cf4c76423d93fbbd8 Mon Sep 17 00:00:00 2001 From: Antonio Jesus Navarro Perez Date: Tue, 28 Feb 2017 11:56:10 +0100 Subject: _examples: improve documentation --- _examples/remotes/main.go | 7 +++++++ 1 file changed, 7 insertions(+) (limited to '_examples/remotes') diff --git a/_examples/remotes/main.go b/_examples/remotes/main.go index 9537fea..8c59a67 100644 --- a/_examples/remotes/main.go +++ b/_examples/remotes/main.go @@ -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" +// - List remotes and print them +// - Pull using the new remote "example" +// - Iterate again the references, but only showing hash references, not simbolic ones +// - Remove remote "example" func main() { // Create a new repository Info("git init") -- cgit From d24ea4984ce6871ea24eb376325082602c766295 Mon Sep 17 00:00:00 2001 From: Antonio Jesus Navarro Perez Date: Tue, 28 Feb 2017 12:21:02 +0100 Subject: Fix typos --- _examples/remotes/main.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to '_examples/remotes') diff --git a/_examples/remotes/main.go b/_examples/remotes/main.go index 8c59a67..06ffdd1 100644 --- a/_examples/remotes/main.go +++ b/_examples/remotes/main.go @@ -11,11 +11,11 @@ import ( ) // Example of how to: -// - Create a new repository into memory -// - Create a new remote called "example" +// - Create a new in-memory repository +// - Create a new remote named "example" // - List remotes and print them // - Pull using the new remote "example" -// - Iterate again the references, but only showing hash references, not simbolic ones +// - Iterate the references again, but only showing hash references, not symbolic ones // - Remove remote "example" func main() { // Create a new repository -- cgit