Skip to content

Commit af3487d

Browse files
authored
Merge pull request go-git#1004 from LukaszKokot/fix/spelling-grammar-doc-example
Fix spelling and grammar in docs and example
2 parents 414b027 + 190bfd6 commit af3487d

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

Diff for: README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55

66
It can be used to manipulate git repositories at low level *(plumbing)* or high level *(porcelain)*, through an idiomatic Go API. It also supports several types of storage, such as in-memory filesystems, or custom implementations thanks to the [`Storer`](https://godoc.org/gopkg.in/src-d/go-git.v4/plumbing/storer) interface.
77

8-
It's being actively develop since 2015 and is being use extensively by [source{d}](https://sourced.tech/) and [Keybase](https://keybase.io/blog/encrypted-git-for-everyone), and by many other libraries and tools.
8+
It's being actively developed since 2015 and is being used extensively by [source{d}](https://sourced.tech/) and [Keybase](https://keybase.io/blog/encrypted-git-for-everyone), and by many other libraries and tools.
99

1010
Comparison with git
1111
-------------------
1212

1313
*go-git* aims to be fully compatible with [git](https://github.com/git/git), all the *porcelain* operations are implemented to work exactly as *git* does.
1414

15-
*git* is a humongous project with years of development by thousands of contributors, making it challenging for *go-git* implement all the features. You can find a comparison of *go-git* vs *git* in the [compatibility documentation](COMPATIBILITY.md).
15+
*git* is a humongous project with years of development by thousands of contributors, making it challenging for *go-git* to implement all the features. You can find a comparison of *go-git* vs *git* in the [compatibility documentation](COMPATIBILITY.md).
1616

1717

1818
Installation
@@ -24,12 +24,12 @@ The recommended way to install *go-git* is:
2424
go get -u gopkg.in/src-d/go-git.v4/...
2525
```
2626

27-
> We use [gopkg.in](http://labix.org/gopkg.in) for having a versioned API, this means that when `go get` clones the package, is the latest tag matching `v4.*` cloned and not the master branch.
27+
> We use [gopkg.in](http://labix.org/gopkg.in) to version the API, this means that when `go get` clones the package, it's the latest tag matching `v4.*` that is cloned and not the master branch.
2828
2929
Examples
3030
--------
3131

32-
> Please note that the functions `CheckIfError` and `Info` used in the examples are from the [examples package](https://github.com/src-d/go-git/blob/master/_examples/common.go#L17) just to be used in the examples.
32+
> Please note that the `CheckIfError` and `Info` functions used in the examples are from the [examples package](https://github.com/src-d/go-git/blob/master/_examples/common.go#L17) just to be used in the examples.
3333
3434

3535
### Basic example
@@ -71,7 +71,7 @@ r, err := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{
7171

7272
CheckIfError(err)
7373

74-
// Gets the HEAD history from HEAD, just like does:
74+
// Gets the HEAD history from HEAD, just like this command:
7575
Info("git log")
7676

7777
// ... retrieves the branch pointed by HEAD
@@ -110,7 +110,7 @@ Date: Fri Nov 11 13:23:22 2016 +0100
110110
...
111111
```
112112

113-
You can find this [example](_examples/log/main.go) and many others at the [examples](_examples) folder
113+
You can find this [example](_examples/log/main.go) and many others in the [examples](_examples) folder.
114114

115115
Contribute
116116
----------

Diff for: _examples/checkout/main.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ func main() {
3838
})
3939
CheckIfError(err)
4040

41-
// ... retrieving the commit being pointed by HEAD, it's shows that the
42-
// repository is poiting to the giving commit in detached mode
41+
// ... retrieving the commit being pointed by HEAD, it shows that the
42+
// repository is pointing to the giving commit in detached mode
4343
Info("git show-ref --head HEAD")
4444
ref, err = r.Head()
4545
CheckIfError(err)

Diff for: _examples/commit/main.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ import (
1212
"gopkg.in/src-d/go-git.v4/plumbing/object"
1313
)
1414

15-
// Basic example of how to commit changes to the current branch to an existent
15+
// Basic example of how to commit changes to the current branch to an existing
1616
// repository.
1717
func main() {
1818
CheckArgs("<directory>")
1919
directory := os.Args[1]
2020

21-
// Opens an already existent repository.
21+
// Opens an already existing repository.
2222
r, err := git.PlainOpen(directory)
2323
CheckIfError(err)
2424

@@ -44,7 +44,7 @@ func main() {
4444

4545
fmt.Println(status)
4646

47-
// Commits the current staging are to the repository, with the new file
47+
// Commits the current staging area to the repository, with the new file
4848
// just created. We should provide the object.Signature of Author of the
4949
// commit.
5050
Info("git commit -m \"example go-git commit\"")

Diff for: _examples/log/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ func main() {
2323
})
2424
CheckIfError(err)
2525

26-
// Gets the HEAD history from HEAD, just like does:
26+
// Gets the HEAD history from HEAD, just like this command:
2727
Info("git log")
2828

2929
// ... retrieves the branch pointed by HEAD

Diff for: _examples/open/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ func main() {
1414
CheckArgs("<path>")
1515
path := os.Args[1]
1616

17-
// We instance a new repository targeting the given path (the .git folder)
17+
// We instanciate a new repository targeting the given path (the .git folder)
1818
r, err := git.PlainOpen(path)
1919
CheckIfError(err)
2020

Diff for: _examples/pull/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ func main() {
1313
CheckArgs("<path>")
1414
path := os.Args[1]
1515

16-
// We instance a new repository targeting the given path (the .git folder)
16+
// We instance\iate a new repository targeting the given path (the .git folder)
1717
r, err := git.PlainOpen(path)
1818
CheckIfError(err)
1919

Diff for: _examples/showcase/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
// - Get the HEAD reference
1717
// - Using the HEAD reference, obtain the commit this reference is pointing to
1818
// - Print the commit content
19-
// - Using the commit, iterate all its files and print them
19+
// - Using the commit, iterate over all its files and print them
2020
// - Print all the commit history with commit messages, short hash and the
2121
// first line of the commit message
2222
func main() {

Diff for: _examples/storage/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77

88
### and what this means ...
9-
*git* has as very well defined storage system, the `.git` directory, present on any repository. This is the place where `git` stores al the [`objects`](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects), [`references`](https://git-scm.com/book/es/v2/Git-Internals-Git-References) and [`configuration`](https://git-scm.com/docs/git-config#_configuration_file). This information is stored in plain files.
9+
*git* has a very well defined storage system, the `.git` directory, present on any repository. This is the place where `git` stores all the [`objects`](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects), [`references`](https://git-scm.com/book/es/v2/Git-Internals-Git-References) and [`configuration`](https://git-scm.com/docs/git-config#_configuration_file). This information is stored in plain files.
1010

1111
Our original **go-git** version was designed to work in memory, some time after we added support to read the `.git`, and now we have added support for fully customized [storages](https://godoc.org/gopkg.in/src-d/go-git.v4/storage#Storer).
1212

Diff for: _examples/tag/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ func main() {
1515
CheckArgs("<path>")
1616
path := os.Args[1]
1717

18-
// We instance a new repository targeting the given path (the .git folder)
18+
// We instanciate a new repository targeting the given path (the .git folder)
1919
r, err := git.PlainOpen(path)
2020
CheckIfError(err)
2121

0 commit comments

Comments
 (0)