slices: misc improvements to godoc #30
Merged
Commits on Nov 14, 2023
-
-
Update godoc to reference items instead of arr
In many cases the godoc for slices was referencing "arr", but all functions use "items" as the slice name. "arr" is also misleading since users could assume this refers to the backing array.
-
-
-
-
-
-
Improve godoc consistency in slice_func.go
- Add full stops to sentences. - Remove the occasional inconsistent use of `code formatting`, which is not typically rendered in godoc. - Add particles to sentences where appropriate to improve readability.
-
-
-
-
-
-
Consistency pass over slice.go and slices.go
- Add full stops to sentences. - Add particles to sentences where appropriate to improve readability. - Always describe the primary slice as `items` to match the argument names. - Reword some godoc to improve grammar or clarify behaviour.
-
Improve godoc for Product and friends
I haven't convinced myself that these are actually cartesian product implementations, but my math brain hasn't been used in a while so I have focused on the godoc.
-
Zip can be a little confusing without an example, so I have tried to add a concise explanation and example to the godoc. The `ExampleZip()` contains excellent examples so perhaps the docs should refer people to that instead?
-
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.