Docs and minor ergonomic changes #2
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* go test * godoc * addiitional setup for godoc install * Corrects goimports (this command may still take some nuancing)
Docs for remaining functions and factory structures.
Tests need to be tested without cache at times to prove their idempotency.
je4
approved these changes
Nov 22, 2024
Ordering in YAML and TOML meant that comparison of strings was failing. We make sure that the tests pass consistently here by re-loading the data back into memory and comparing the data on a structural level.
We replace the magic number for the default weight at the same time.
Docs examples are tested as part of `go test` and so they remain up-to-date when they are changed in error. They are also useful entry-points when looking at the library via the docs.
|
@je4 just requesting re-review on these. I noticed some issues with the unit tests as they were (more info in the respective commit). And I have made some changes to the README.md to provide some more interactivity via godocs and also some plain-examples on the README. |
je4
approved these changes
Nov 22, 2024
ross-spencer
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
justfilehelpers.go testthey are also runnable in the online godoc package registry. Offline docs based example look as follows (docs can be started usingjust docs: