Skip to content

cmd/gofmt: flag documentation #31228

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

Closed
Konstantin8105 opened this issue Apr 3, 2019 · 5 comments
Closed

cmd/gofmt: flag documentation #31228

Konstantin8105 opened this issue Apr 3, 2019 · 5 comments
Labels
Documentation Issues describing a change to documentation. help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@Konstantin8105
Copy link
Contributor

Documentation is not same:

gofmt -h
usage: gofmt [flags] [path ...]                                  -cpuprofile string                                                   write cpu profile to this file                           -d    display diffs instead of rewriting files                 -e    report all errors (not just the first 10 on different lines)                                                            -l    list files whose formatting differs from gofmt's         -r string                                                            rewrite rule (e.g., 'a[b:len(a)] -> a[b:]')              -s    simplify code                                            -w    write result to (source) file instead of stdout

And https://golang.org/cmd/gofmt/

@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Apr 3, 2019
@Konstantin8105
Copy link
Contributor Author

Also see go doc cmd/gofmt

@DylanMeeus
Copy link

It seems to me that the documentation needs to be updated to match the output from gofmt -h. Rather than having gofmt -h updated to reflect the documentation?

If that's the case, is it OK if I open a PR for this by altering the doc.go in cmd/gofmt?
So I have something small to contribute 😅

@Konstantin8105
Copy link
Contributor Author

Us I understood, gofmt -h is correct, but not correct on other places.
Feel free for contribute.

@FiloSottile FiloSottile changed the title cmd/gofmt : flag documentation cmd/gofmt: flag documentation Apr 3, 2019
@andybons andybons added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Apr 3, 2019
@andybons andybons added this to the Unplanned milestone Apr 3, 2019
@gopherbot
Copy link
Contributor

Change https://golang.org/cl/170679 mentions this issue: cmd/gofmt: have the doc.go match -h output

@seankhliao
Copy link
Member

I believe the flags align now (though the text may be different).

@seankhliao seankhliao closed this as not planned Won't fix, can't repro, duplicate, stale Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues describing a change to documentation. help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

5 participants