Summary:

[Outdated] Basic Util Files For GoDiffX

Review Request #11830 — Created Oct. 1, 2021 and updated Nov. 24, 2021, noon

Information
Owner:	jordanvandenbruel
Repository:	DiffX
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	diffx
People:

Description

All of the basic files have now been created along with some tests. This includes errors,
sections, options, text, and unified diffs.

I added the outdated tag because I started overwriting some of these basic things while
working on reader.go. It also does not make much sense to ship this on its own since
there aren't really any useful functions.

Testing Done

A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
I setup the local test file to think it's getting its information from
github.com/beanbaginc/diffx/go/godiffx when in reality, it is just checking my local copy. I can
overwrite this whenever code gets published to make sure it still works properly, but that is likely
something that can come towards the end of the project.

There is testing written for every file now and Go reports it having 98.1% coverage. The remaining 1.9%
is due to small redundancies in error handling where I don't expect a function to ever error at a certain
point, but I have code to handle it in case something odd happens.

The only other piece that still needs to be tested is the Go docs themselves. I have not had enough time
to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
and will update this description once that is finished. I don't expect any issues but this is my first time
creating go docs so we will see.

Commits

Summary		Author
	Create LICENSE and README for project	Jordan
	Create basic support files for diffx.	Jordan
	Write basic constants for options.go	Jordan
	Wrote code for sections.go	Jordan
	Update documentation for sections.go	Jordan
	Write all custom errors for godiffx.	Jordan
	Add documentation and fix line value for DiffXParseError	Jordan
	Create text values and write SplitLines	Jordan
	Fix Errors and Write StripBom Method.	Jordan
	Created test files and wrote init tests for Errors.go	Jordan
	Finish tests for errors.go	Jordan
	Add testing for sections.go	Jordan
	Wrote unit tests for finished functions in text.go	Jordan
	Create new error for invalid encoding.	Jordan
	Create encode method for text.go	Jordan
	Add GetNewlineForType function in text.go	Jordan
	Finish manually testing all functions for text.go	Jordan
	Write tests for line ending methods.	Jordan
	Wrote unit test for encoding function	Jordan
	Test a few more edge cases in the code.	Jordan
	Write initial documentation for unifiedDiffs.go.	Jordan
	WIP update for unifiedDiffs.go	Jordan
	Finished unified_diffs.go	Jordan
	Write basics for unifiedDiffs testing and fix bugs encountered.	Jordan
	Update unifiedDiff tests to ensure proper returns and tweaked bugs.	Jordan

Screenshots

Issues

Description	From	Last Updated

flake8 passed.

JSHint passed.

Description:

~		Following from the example PyDiffX, the following commits create the files
~		`options.go`, `sections.go`, and `errors.go` to be used in GoDiffX.
	~	Further updates from the previous week include work on `text.go`, the
	~	creation of testing files, and some small tweaks to bugs.
-		They are fairly straightforward files and do not do much on their own.
-		However, they are just a few of the stepping stones needed to get to work on
-		the main problem at hand.

~		`options.go` is just a few enums that can be used to konw what formats or types
~		are available in certain circumstances. While I am not 100% familiar with their
	~	The 'bugs' in question refer to typos in error messages found while testing
	~	and things like no `Error()` method being used for the errors.
-		use in the code, creating them as enums using `iota` seemed to be a simple
-		approach to make the options available.

~		`sections.go` holds the section struct, a key piece of DiffX since it relies on
~		these different sections. One small roadblock when comparing this to PyDiffX is
~		that there are no classes in Go. However, we are still able to use Structs and
~		can replicate the functionality of classes is most cases. Another issue that was
	~	Progress has been made on `Text.go`, but this part of the code took me a while
	~	because it was a lot of learning and experimenting with bytes to better understand
	~	how they are treated by different objects. I have a much better understanding of
	~	the functionality now, but there are a couple more functions that need to be finished up.
-		encountered here is that go does not have access to sets. The workaround for
-		this was to instead create them as maps where the value for each key is just
-		`true`.

~		`errors.go` is a bunch of different errors that our program may need to throw.
~		Errors are handled differently in Go than in Python. Usually, if a function
	~	All of the work from the previous week is still here (i.e. work done on `options.go`,
	~	`sections.go`, and `errors.go`.
-		encounters an error, it will just pass the error up in the function and it is up
-		to the programmer to ensure the error is properly handled. For this reason, the
-		errors themselves will never kill a program. However, they should all still have
-		the same properties (such as line, column, and content) where appropriate. One
-		note about this part is that there were some parts in Python that used unicode
-		as a variable. I believe this is represented as a `rune` in Go, but more
-		research has to be done. Because of this, the unicode parts are just strings for
-		now.

		In each of the files, the proper documentation was added via the inline
		comments. These were also modelled closely after their respective python
		counterparts, but there are some small differences due to Go's documentation
		standards (i.e. requiring the comment to begin with the name of what it is
		talking about).

Testing Done:

		A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
		was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
		I setup the local test file to think it's getting its information from
		`github.com/beanbaginc/diffx/go/godiffx` when in reality, it is just checking my local copy. I can
		overwrite this whenever code gets published to make sure it still works properly, but that is likely
		something that can come towards the end of the project.

		The testing file has been used to test out all of the code I have written. There is more detailed
		information within each of the commits, but the main idea is that I would import the things I made
		and ensure they behave the way I expected them to.

	+	I also have began to write unit testing for `errors.go`
	+
		The only piece that still needs to be tested is the Go docs themselves. I have not had enough time
		to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
		and will update this description once that is finished. I don't expect any issues but this is my first time
		creating go docs so we will see.

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan

Diff:

Revision 2 (+1181 -35)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	Create options, sections, and errors
+	[WIP] Work on Text.go and Testing

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
-	Create text values and write SplitLines	Jordan
-	Fix Errors and Write StripBom Method.	Jordan
-	Created test files and wrote init tests for Errors.go	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan
+	Finish tests for errors.go	Jordan

Diff:

Revision 3 (+1341 -37)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Testing Done:

		A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
		was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
		I setup the local test file to think it's getting its information from
		`github.com/beanbaginc/diffx/go/godiffx` when in reality, it is just checking my local copy. I can
		overwrite this whenever code gets published to make sure it still works properly, but that is likely
		something that can come towards the end of the project.

		The testing file has been used to test out all of the code I have written. There is more detailed
		information within each of the commits, but the main idea is that I would import the things I made
		and ensure they behave the way I expected them to.

~		I also have began to write unit testing for `errors.go`
	~	I also have finished writing unit tests for `errors.go`

		The only piece that still needs to be tested is the Go docs themselves. I have not had enough time
		to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
		and will update this description once that is finished. I don't expect any issues but this is my first time
		creating go docs so we will see.

Summary:

-	[WIP] Work on Text.go and Testing
+	[WIP] Finish Tests for Available Functions

Testing Done:

		A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
		was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
		I setup the local test file to think it's getting its information from
		`github.com/beanbaginc/diffx/go/godiffx` when in reality, it is just checking my local copy. I can
		overwrite this whenever code gets published to make sure it still works properly, but that is likely
		something that can come towards the end of the project.

		The testing file has been used to test out all of the code I have written. There is more detailed
		information within each of the commits, but the main idea is that I would import the things I made
		and ensure they behave the way I expected them to.

~		I also have finished writing unit tests for `errors.go`
	~	I also have finished writing unit tests for all available functions.

		The only piece that still needs to be tested is the Go docs themselves. I have not had enough time
		to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
		and will update this description once that is finished. I don't expect any issues but this is my first time
		creating go docs so we will see.

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
-	Create text values and write SplitLines	Jordan
-	Fix Errors and Write StripBom Method.	Jordan
-	Created test files and wrote init tests for Errors.go	Jordan
-	Finish tests for errors.go	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan
+	Finish tests for errors.go	Jordan
+	Add testing for sections.go	Jordan
+	Wrote unit tests for finished functions in text.go	Jordan

Diff:

Revision 4 (+1998 -38)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Description:

~		Further updates from the previous week include work on `text.go`, the
~		creation of testing files, and some small tweaks to bugs.
~
	~	Only new update is that there is now a test for every function. However,
	~	Go believes we only have ~90% coverage with the tests so I am going to look
	~	and ensure I cover every test case next.
-		The 'bugs' in question refer to typos in error messages found while testing
-		and things like no `Error()` method being used for the errors.
-
-		Progress has been made on `Text.go`, but this part of the code took me a while
-		because it was a lot of learning and experimenting with bytes to better understand
-		how they are treated by different objects. I have a much better understanding of
-		the functionality now, but there are a couple more functions that need to be finished up.
-
-		All of the work from the previous week is still here (i.e. work done on `options.go`,
-		`sections.go`, and `errors.go`.
-
-		In each of the files, the proper documentation was added via the inline
-		comments. These were also modelled closely after their respective python
-		counterparts, but there are some small differences due to Go's documentation
-		standards (i.e. requiring the comment to begin with the name of what it is
-		talking about).

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
-	Create text values and write SplitLines	Jordan
-	Fix Errors and Write StripBom Method.	Jordan
-	Created test files and wrote init tests for Errors.go	Jordan
-	Finish tests for errors.go	Jordan
-	Add testing for sections.go	Jordan
-	Wrote unit tests for finished functions in text.go	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan
+	Finish tests for errors.go	Jordan
+	Add testing for sections.go	Jordan
+	Wrote unit tests for finished functions in text.go	Jordan
+	Create new error for invalid encoding.	Jordan
+	Create encode method for text.go	Jordan
+	Add GetNewlineForType function in text.go	Jordan
+	Finish manually testing all functions for text.go	Jordan
+	Write tests for line ending methods.	Jordan
+	Wrote unit test for encoding function	Jordan

Diff:

Revision 5 (+2544 -46)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	[WIP] Finish Tests for Available Functions
+	[WIP] Begin Work on unifiedDiffs.go

Description:

~		Only new update is that there is now a test for every function. However,
~		Go believes we only have ~90% coverage with the tests so I am going to look
~		and ensure I cover every test case next.
	~	Started work on unifiedDiffs.go and now have the functionality to just identify the header along with the regex. Most of the week
	~	was spent trying to learn regex and understand how the python implementation works. There was also the piece of figuring out how to
	~	change the pythonic code into something that works with golang (because of dictionaries and loosely typed variables).

Testing Done:

		A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
		was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
		I setup the local test file to think it's getting its information from
		`github.com/beanbaginc/diffx/go/godiffx` when in reality, it is just checking my local copy. I can
		overwrite this whenever code gets published to make sure it still works properly, but that is likely
		something that can come towards the end of the project.

~		The testing file has been used to test out all of the code I have written. There is more detailed
	~	I have testing done for every file except this new one.
-		information within each of the commits, but the main idea is that I would import the things I made
-		and ensure they behave the way I expected them to.

~		I also have finished writing unit tests for all available functions.
	~	The only other piece that still needs to be tested is the Go docs themselves. I have not had enough time
-
-		The only piece that still needs to be tested is the Go docs themselves. I have not had enough time
		to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
		and will update this description once that is finished. I don't expect any issues but this is my first time
		creating go docs so we will see.

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
-	Create text values and write SplitLines	Jordan
-	Fix Errors and Write StripBom Method.	Jordan
-	Created test files and wrote init tests for Errors.go	Jordan
-	Finish tests for errors.go	Jordan
-	Add testing for sections.go	Jordan
-	Wrote unit tests for finished functions in text.go	Jordan
-	Create new error for invalid encoding.	Jordan
-	Create encode method for text.go	Jordan
-	Add GetNewlineForType function in text.go	Jordan
-	Finish manually testing all functions for text.go	Jordan
-	Write tests for line ending methods.	Jordan
-	Wrote unit test for encoding function	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan
+	Finish tests for errors.go	Jordan
+	Add testing for sections.go	Jordan
+	Wrote unit tests for finished functions in text.go	Jordan
+	Create new error for invalid encoding.	Jordan
+	Create encode method for text.go	Jordan
+	Add GetNewlineForType function in text.go	Jordan
+	Finish manually testing all functions for text.go	Jordan
+	Write tests for line ending methods.	Jordan
+	Wrote unit test for encoding function	Jordan
+	Test a few more edge cases in the code.	Jordan
+	Write initial documentation for unifiedDiffs.go.	Jordan
+	WIP update for unifiedDiffs.go	Jordan

Diff:

Revision 6 (+2975 -55)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	[WIP] Begin Work on unifiedDiffs.go
+	[WIP] Finish unifiedDiffs.go and Implement Basic Testing.

Description:

~		Started work on unifiedDiffs.go and now have the functionality to just identify the header along with the regex. Most of the week
~		was spent trying to learn regex and understand how the python implementation works. There was also the piece of figuring out how to
~		change the pythonic code into something that works with golang (because of dictionaries and loosely typed variables).
	~	Wrote all of the code for unifiedDiffs.go and manually tested a few cases. Also wrote basic tests
	~	based on the python version. There is now a test for each case in the python version that does a very
	~	trivial check to ensure the proper number of hunks are returned or that the error is correct. It seems
	+	like it may be challenging to quickly compare the custom struct I return so I will be working on finishing
	+	that next.

Testing Done:

		A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
		was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
		I setup the local test file to think it's getting its information from
		`github.com/beanbaginc/diffx/go/godiffx` when in reality, it is just checking my local copy. I can
		overwrite this whenever code gets published to make sure it still works properly, but that is likely
		something that can come towards the end of the project.

~		I have testing done for every file except this new one.
	~	There is testing written for every file now. There is a small caveat that the testing for unifiedDiffs.go
	+	is still lacking in robustness, but I wanted to just ensure things seemed to be working properly before the
	+	WIP update I posted today.

		The only other piece that still needs to be tested is the Go docs themselves. I have not had enough time
		to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
		and will update this description once that is finished. I don't expect any issues but this is my first time
		creating go docs so we will see.

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
-	Create text values and write SplitLines	Jordan
-	Fix Errors and Write StripBom Method.	Jordan
-	Created test files and wrote init tests for Errors.go	Jordan
-	Finish tests for errors.go	Jordan
-	Add testing for sections.go	Jordan
-	Wrote unit tests for finished functions in text.go	Jordan
-	Create new error for invalid encoding.	Jordan
-	Create encode method for text.go	Jordan
-	Add GetNewlineForType function in text.go	Jordan
-	Finish manually testing all functions for text.go	Jordan
-	Write tests for line ending methods.	Jordan
-	Wrote unit test for encoding function	Jordan
-	Test a few more edge cases in the code.	Jordan
-	Write initial documentation for unifiedDiffs.go.	Jordan
-	WIP update for unifiedDiffs.go	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan
+	Finish tests for errors.go	Jordan
+	Add testing for sections.go	Jordan
+	Wrote unit tests for finished functions in text.go	Jordan
+	Create new error for invalid encoding.	Jordan
+	Create encode method for text.go	Jordan
+	Add GetNewlineForType function in text.go	Jordan
+	Finish manually testing all functions for text.go	Jordan
+	Write tests for line ending methods.	Jordan
+	Wrote unit test for encoding function	Jordan
+	Test a few more edge cases in the code.	Jordan
+	Write initial documentation for unifiedDiffs.go.	Jordan
+	WIP update for unifiedDiffs.go	Jordan
+	Finished unified_diffs.go	Jordan
+	Write basics for unifiedDiffs testing and fix bugs encountered.	Jordan

Diff:

Revision 7 (+4770 -148)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	5 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	[WIP] Finish unifiedDiffs.go and Implement Basic Testing.
+	Basic Util Files For GoDiffX

Description:

~		Wrote all of the code for unifiedDiffs.go and manually tested a few cases. Also wrote basic tests
~		based on the python version. There is now a test for each case in the python version that does a very
	~	All of the basic files have now been created along with some tests. This includes errors,
	~	sections, options, text, and unified diffs.
-		trivial check to ensure the proper number of hunks are returned or that the error is correct. It seems
-		like it may be challenging to quickly compare the custom struct I return so I will be working on finishing
-		that next.

Testing Done:

		A test file was created on my machine in another directiory (~/Desktop/GoTest) and the module
		was imported there. Since it does not make sense for semi-functional code to be pushed to Github,
		I setup the local test file to think it's getting its information from
		`github.com/beanbaginc/diffx/go/godiffx` when in reality, it is just checking my local copy. I can
		overwrite this whenever code gets published to make sure it still works properly, but that is likely
		something that can come towards the end of the project.

~		There is testing written for every file now. There is a small caveat that the testing for unifiedDiffs.go
~		is still lacking in robustness, but I wanted to just ensure things seemed to be working properly before the
~		WIP update I posted today.
	~	There is testing written for every file now and Go reports it having 98.1% coverage. The remaining 1.9%
	~	is due to small redundancies in error handling where I don't expect a function to ever error at a certain
	~	point, but I have code to handle it in case something odd happens.

		The only other piece that still needs to be tested is the Go docs themselves. I have not had enough time
		to spin up a local server where I can see what the documentation looks like, but I plan to do that soon
		and will update this description once that is finished. I don't expect any issues but this is my first time
		creating go docs so we will see.

Commits:

		Author
-	Create LICENSE and README for project	Jordan
-	Create basic support files for diffx.	Jordan
-	Write basic constants for options.go	Jordan
-	Wrote code for sections.go	Jordan
-	Update documentation for sections.go	Jordan
-	Write all custom errors for godiffx.	Jordan
-	Add documentation and fix line value for DiffXParseError	Jordan
-	Create text values and write SplitLines	Jordan
-	Fix Errors and Write StripBom Method.	Jordan
-	Created test files and wrote init tests for Errors.go	Jordan
-	Finish tests for errors.go	Jordan
-	Add testing for sections.go	Jordan
-	Wrote unit tests for finished functions in text.go	Jordan
-	Create new error for invalid encoding.	Jordan
-	Create encode method for text.go	Jordan
-	Add GetNewlineForType function in text.go	Jordan
-	Finish manually testing all functions for text.go	Jordan
-	Write tests for line ending methods.	Jordan
-	Wrote unit test for encoding function	Jordan
-	Test a few more edge cases in the code.	Jordan
-	Write initial documentation for unifiedDiffs.go.	Jordan
-	WIP update for unifiedDiffs.go	Jordan
-	Finished unified_diffs.go	Jordan
-	Write basics for unifiedDiffs testing and fix bugs encountered.	Jordan
+	Create LICENSE and README for project	Jordan
+	Create basic support files for diffx.	Jordan
+	Write basic constants for options.go	Jordan
+	Wrote code for sections.go	Jordan
+	Update documentation for sections.go	Jordan
+	Write all custom errors for godiffx.	Jordan
+	Add documentation and fix line value for DiffXParseError	Jordan
+	Create text values and write SplitLines	Jordan
+	Fix Errors and Write StripBom Method.	Jordan
+	Created test files and wrote init tests for Errors.go	Jordan
+	Finish tests for errors.go	Jordan
+	Add testing for sections.go	Jordan
+	Wrote unit tests for finished functions in text.go	Jordan
+	Create new error for invalid encoding.	Jordan
+	Create encode method for text.go	Jordan
+	Add GetNewlineForType function in text.go	Jordan
+	Finish manually testing all functions for text.go	Jordan
+	Write tests for line ending methods.	Jordan
+	Wrote unit test for encoding function	Jordan
+	Test a few more edge cases in the code.	Jordan
+	Write initial documentation for unifiedDiffs.go.	Jordan
+	WIP update for unifiedDiffs.go	Jordan
+	Finished unified_diffs.go	Jordan
+	Write basics for unifiedDiffs testing and fix bugs encountered.	Jordan
+	Update unifiedDiff tests to ensure proper returns and tweaked bugs.	Jordan

Diff:

Revision 8 (+4849 -323)

Show changes

	go/LICENSE
	go/README.md
	go/godiffx/errors.go
	go/godiffx/errors_test.go
	go/godiffx/go.mod
	go/godiffx/options.go
	go/godiffx/sections.go
	go/godiffx/sections_test.go
	5 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	Basic Util Files For GoDiffX
+	[Outdated] Basic Util Files For GoDiffX

Description:

		All of the basic files have now been created along with some tests. This includes errors,
		sections, options, text, and unified diffs.
	+
	+	I added the outdated tag because I started overwriting some of these basic things while
	+	working on reader.go. It also does not make much sense to ship this on its own since
	+	there aren't really any useful functions.