Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up some documentation #1688

Merged
merged 2 commits into from
Mar 2, 2023
Merged

Conversation

docwhat
Copy link
Contributor

@docwhat docwhat commented Feb 25, 2023

What type of PR is this?

  • documentation

What this PR does / why we need it:

Improve the pkg.go.dev documentation.

Which issue(s) this PR fixes:

None.

Release Notes

-->

NONE

@docwhat docwhat requested a review from a team as a code owner February 25, 2023 21:47
dearchap
dearchap previously approved these changes Feb 26, 2023
@dearchap
Copy link
Contributor

@docwhat Can you run make diffcheck and/or make v3approve ?

@docwhat
Copy link
Contributor Author

docwhat commented Feb 26, 2023

@docwhat Can you run make diffcheck and/or make v3approve ?

Sure!

❯ make diffcheck
go run internal/build/build.go  diffcheck
# ---> /usr/bin/git rev-parse --show-toplevel
# ---> /usr/bin/git diff --exit-code
# ---> /usr/bin/git diff --cached --exit-code
❯ make v3approve
go run internal/build/build.go  v3approve
# ---> /usr/bin/git rev-parse --show-toplevel
# ---> /bin/cp -v godoc-current.txt testdata/godoc-v3.x.txt
godoc-current.txt -> testdata/godoc-v3.x.txt
❯ git status --short --branch --show-stash
## before-after-docs...docwhat/before-after-docs

What is supposed to do something?

Or is the output what we want?

@avorima
Copy link
Contributor

avorima commented Feb 27, 2023

@docwhat You need make generate v3approve. When you change the godoc, files need to be re-generated.

Copy link
Contributor

@dearchap dearchap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @docwhat

@dearchap dearchap merged commit 3b1034a into urfave:main Mar 2, 2023
@docwhat docwhat deleted the before-after-docs branch March 7, 2023 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants