From ea24f0643a5bb07528eca728f6b9c37a41e40fde Mon Sep 17 00:00:00 2001 From: gonejack Date: Mon, 11 May 2020 12:02:04 +0800 Subject: [PATCH] go-doc: apply suggestion Signed-off-by: gonejack --- pages/common/go-doc.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/pages/common/go-doc.md b/pages/common/go-doc.md index c128d6a8f7..f4a031611c 100644 --- a/pages/common/go-doc.md +++ b/pages/common/go-doc.md @@ -1,12 +1,24 @@ # go doc -> Tool for showing documentation for package or symbol. -> More information: . +> Show documentation for package or symbol. +> More information: . -- Show documentation for {{Foo}} in the current package: +- Show documentation for current package: -`go doc {{Foo}}` +`go doc` -- Show documentation and method summary for {{json.Number}}: +- Show package documentation and exported symbols: -`go doc {{json.Number}}` +`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}}`