From 23102a398bac27166dcb60b5b375c77fe0393934 Mon Sep 17 00:00:00 2001 From: ccoVeille <3875889+ccoVeille@users.noreply.github.com> Date: Wed, 17 Jul 2024 17:18:18 +0200 Subject: [PATCH] chore: fix typos and style --- .github/CONTRIBUTING.md | 4 ++-- README.md | 2 +- dumper.go | 8 ++++---- dumper_test.go | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index dc03f16..cc89e9e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -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 @@ -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 diff --git a/README.md b/README.md index bc4cb33..d0f842c 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/dumper.go b/dumper.go index 154f8eb..68c8d10 100644 --- a/dumper.go +++ b/dumper.go @@ -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 } @@ -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 { @@ -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 { @@ -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)) diff --git a/dumper_test.go b/dumper_test.go index 1a4feb3..6d3f7e4 100644 --- a/dumper_test.go +++ b/dumper_test.go @@ -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])) }