1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-22 17:22:10 +02:00
tldr/pages/common/go-doc.md
Vitor Henrique e7d5609dd3
pages*: improve list placeholders and wording of descriptions (#12111)
* pages*: improve wording and list placeholders

* clamav: fix verb tenses

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>

* buzzphrase: use k instead of n for number of phrases

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>

* adguardhome: use non-default instead of different

* adguardhome: use configuration instead of config

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* goimports, module: fix list placeholders

Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* pages*: leave stems and extensions in the same placeholders

* pages*: fix list placeholders

* pages*: fix list placeholders

* pages*: apply suggestions from code review

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>

* qpdf: enclose n with backticks

Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>

---------

Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: Lena <126529524+acuteenvy@users.noreply.github.com>
2024-01-31 09:25:19 +05:30

24 lines
492 B
Markdown

# go doc
> View documentation for a package or symbol.
> More information: <https://golang.org/cmd/go/#hdr-Show_documentation_for_package_or_symbol>.
- View documentation for the current package:
`go doc`
- Show package documentation and exported symbols:
`go doc {{encoding/json}}`
- Show also documentation of symbols:
`go doc -all {{encoding/json}}`
- Show also sources:
`go doc -all -src {{encoding/json}}`
- Show a specific symbol:
`go doc -all -src {{encoding/json.Number}}`