Skip to content

Commit

Permalink
Merge pull request #50 from ccoVeille/typos-suggestion
Browse files Browse the repository at this point in the history
chore: fix typos and style
  • Loading branch information
yassinebenaid authored Jul 18, 2024
2 parents bf5d318 + 23102a3 commit a5a63ef
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Refer this project in your project's README
> - Mention the project at local meetups and tell your friends/colleagues
## Table of Contents
Expand Down Expand Up @@ -78,7 +78,7 @@ Once it's filed:

- The project maintainer will label the issue accordingly.
- The maintainer will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the maintainer will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
- If the maintainer is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be implemented as soo as the maintainer is free to do or someone opens a PR to handle it.
- If the maintainer is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be implemented as soon as the maintainer is free to do or someone opens a PR to handle it.


### Suggesting Enhancements
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ Output:

### Example 4.

This example emphasizes how you can generate html
This example emphasizes how you can generate HTML

```go
package main
Expand Down
8 changes: 4 additions & 4 deletions dumper.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func __(s Style, v string) string {
return s.Apply(v)
}

// RGB implements [Style] and allow you to define your style as an RGB value, it uses ANSI escape sequences under the hood.
// RGB implements [Style] and allows you to define your style as an RGB value, it uses ANSI escape sequences under the hood.
type RGB struct {
R, G, B int
}
Expand Down Expand Up @@ -123,7 +123,7 @@ func (d *Dumper) Print(v any) error {
return d.Fprint(os.Stdout, v)
}

// Println formats `v` , appends a new line and writes the result to standard output.
// Println formats `v`, appends a new line, and writes the result to standard output.
//
// It returns a write error if encountered while writing to standard output.
func (d *Dumper) Println(v any) error {
Expand All @@ -142,7 +142,7 @@ func (d *Dumper) Fprint(dst io.Writer, v any) error {
return nil
}

// Fprintln formats `v` , appends a new line and writes the result to `dst`.
// Fprintln formats `v`, appends a new line, and writes the result to `dst`.
//
// It returns a write error if encountered while writing to `dst`.
func (d *Dumper) Fprintln(dst io.Writer, v any) error {
Expand All @@ -162,7 +162,7 @@ func (d *Dumper) Sprint(v any) string {
return d.buf.String()
}

// Sprintln formats `v`, appends a new line and returns the resulting string.
// Sprintln formats `v`, appends a new line, and returns the resulting string.
func (d *Dumper) Sprintln(v any) string {
d.init()
d.dump(reflect.ValueOf(v))
Expand Down
2 changes: 1 addition & 1 deletion dumper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,7 @@ func checkFromFeed(t *testing.T, result []byte, feed_path string) {

for i, line := range e_lines {
if string(line) != string(r_lines[i]) {
t.Fatalf(`mismatche at line %d:
t.Fatalf(`mismatch at line %d:
--- "%s" (%d)
+++ "%s" (%d)`, i+1, line, len(line), r_lines[i], len(r_lines[i]))
}
Expand Down

0 comments on commit a5a63ef

Please sign in to comment.