gofrs / uuid

A UUID package for Go
MIT License
1.57k stars 110 forks source link

all: gofmt with Go 1.19 #110

Closed charlievieth closed 1 year ago

charlievieth commented 1 year ago

Go 1.19 adds doc comments. This commit runs gofmt on all the code to update the comments.

https://tip.golang.org/doc/go1.19#go-doc

codecov-commenter commented 1 year ago

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage :thumbsup:

Coverage data is based on head (19b5399) compared to base (ebca088). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #110 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 4 4 Lines 448 448 ========================================= Hits 448 448 ``` | [Impacted Files](https://codecov.io/gh/gofrs/uuid/pull/110?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofrs) | Coverage Δ | | |---|---|---| | [codec.go](https://codecov.io/gh/gofrs/uuid/pull/110?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofrs#diff-Y29kZWMuZ28=) | `100.00% <ø> (ø)` | | | [uuid.go](https://codecov.io/gh/gofrs/uuid/pull/110?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofrs#diff-dXVpZC5nbw==) | `100.00% <ø> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofrs). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=gofrs)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

dylan-bourque commented 1 year ago

Changes seem 👍 on the surface. What does the updated godoc actually look like, @charlievieth? It should be fine since the indented blocks should render well in 1.18 or earlier but it's best to verify before moving forward.

charlievieth commented 1 year ago

Verified that there is no change in presentation (I think pkg.go.dev might already be applying these changes - all that gofmt is now doing is trying to make the "semantic meaning" of comments clearer).

The changes here are just the result of gofmt (as of 1.19) adjusting the code blocks to match the expected format (there is also one change that adds the new build tag format but thats been around for a bit).

See the "Code Blocks" section of doc/comment for more information.

cameracker commented 1 year ago

@charlievieth thanks for taking the time to clean up the code here. Would you mind rerunning this against tip master? It looks like the major rework PR yielded some conflicts 👍

charlievieth commented 1 year ago

@charlievieth thanks for taking the time to clean up the code here. Would you mind rerunning this against tip master? It looks like the major rework PR yielded some conflicts 👍

Done and thanks for the quick review.