Merge pull request #48 from ccoVeille/typos-suggestion

chore: fix typos and style

.github/CONTRIBUTING.md

@@ -49,7 +49,7 @@ We will then take care of the issue as soon as possible.
 
 ## I Want To Contribute
 
-> ### Legal Notice 
+> ### Legal Notice
 > When contributing to this project, you must agree that you have authored 100% of the code, that you have the necessary rights to the code and that the code you contribute may be provided under the project license.
 
 ### Reporting Bugs
@@ -59,13 +59,13 @@ We will then take care of the issue as soon as possible.
 A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
 
 - Make sure that you are using the latest version.
-- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/yassinebenaid/godump). If you are looking for support, you might want to readI `i have a question` section).
+- Determine if your bug is really a bug and not an error on your side e.g., using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/yassinebenaid/godump). If you are looking for support, you might want to read `i have a question` section).
 - Possibly your input and the output
 - Can you reliably reproduce the issue? And can you also reproduce it with older versions?
 
 #### How Do I Submit a Good Bug Report?
 
-> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <[email protected]>.
+> You must never report security related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead, sensitive bugs must be sent by email to <[email protected]>.
 
 We use GitHub issues to track bugs and errors. If you run into an issue with the project:
 
@@ -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 openes 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 soo as the maintainer is free to do or someone opens a PR to handle it.
 
 
 ### Suggesting Enhancements

README.md

@@ -23,7 +23,7 @@
 
 A versatile Go library designed to output any Go variable in a structured and colored format.
 
-This library is especially useful for debugging and testing when the standard fmt library falls short in displaying arbitrary data effectively. It can also serve as a powerful logging adapter, providing clear and readable logs for both development and production environments.
+This library is especially useful for debugging and testing when the standard `fmt` library falls short in displaying arbitrary data effectively. It can also serve as a powerful logging adapter, providing clear and readable logs for both development and production environments.
 
 `godump` is not here to replace the `fmt` package. Instead, it provides an extension to what the `fmt.Printf("%#v")` can do.
 
@@ -32,7 +32,7 @@ This library is especially useful for debugging and testing when the standard fm
 - ability to pretty print values of all types
 - well formatted output
 - unexported structs are dumped too
-- pointers are followed and recursive pointers are taken in mind ([see examples](#example-3))
+- pointers are followed, and recursive pointers are taken in mind ([see examples](#example-3))
 - customizable, you have full control over the output, **you can even generate HTML if you'd like to**, [see examples](#example-4)
 - zero dependencies
 
@@ -59,7 +59,7 @@ func main() {
 
 ```
 
-## Cusomization
+## Customization
 
 If you need more control over the output. Use the `Dumper`
 
@@ -140,7 +140,7 @@ Output:
 
 ### Example 3.
 
-This example shows how recursive pointers are handeled
+This example shows how recursive pointers are handled.
 
 ```go
 package main
@@ -187,7 +187,7 @@ import (
 	"github.com/yassinebenaid/godump"
 )
 
-// Define your custome style implementation
+// Define your custom style implementation
 type CSSColor struct {
 	R, G, B int
 }
@@ -236,8 +236,8 @@ Output:
 
 ![theme](./demo/theme.png)
 
-For more examples, please have a look at [dumper_test](./dumper_test.go) along with [testdata](./testdata)
+For more examples, please take a look at [dumper_test](./dumper_test.go) along with [testdata](./testdata)
 
 ## Contribution
 
-Please read [CONTRIBUTING guildlines](.github/CONTRIBUTING.md)
+Please read [CONTRIBUTING guidelines](.github/CONTRIBUTING.md)

dumper.go

@@ -44,7 +44,7 @@ type Theme struct {
 	// Number defines the style used for numbers, including all types of integers, floats and complex numbers.
 	Number Style
 
-	// Types defines the style used for defined and/or structural types, eg. slices, structs, maps...
+	// Types defines the style used for defined and/or structural types, eg., slices, structs, maps...
 	Types Style
 
 	// Nil defines the style used for nil.
@@ -98,7 +98,7 @@ func DisableColors() {
 
 // Dumper provides an elegant interface to pretty print any variable of any type in a colored and structured format.
 //
-// The zero value for Dumper is a themeless Dumper ready to use.
+// The zero value for Dumper is a theme-less Dumper ready to use.
 type Dumper struct {
 	// Indentation is an optional string used for indentation.
 	// The default value is a string of three spaces.

godump.go

@@ -7,7 +7,7 @@ func Dump(v any) error {
 	}).Println(v)
 }
 
-// DumpNC is just like Dump but doesn't produce any colors , useful if you want to write to a file or stream.
+// DumpNC is just like Dump but doesn't produce any colors, useful if you want to write to a file or stream.
 //
 // Deprecated: As of v0.8.0 this function only calls [Dumper.Println].
 func DumpNC(v any) error {