Skip to content

Commit 998ee33

Browse files
bitluxgopherbot
authored andcommitted
_content/doc: add a table of contents to comment.md
comment.md is longer than pgo.md and build-cover.md, both of which have tables of contents. Change-Id: Ie73e2405d0d1ac9c245544066250f62f244cbead Reviewed-on: https://go-review.googlesource.com/c/website/+/664598 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Auto-Submit: Sean Liao <sean@liao.dev> Reviewed-by: Michael Pratt <mpratt@google.com> Reviewed-by: Sean Liao <sean@liao.dev> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
1 parent 48613ad commit 998ee33

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

_content/doc/comment.md

+11
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ layout: article
44
date: 2022-06-01T00:00:00Z
55
---
66

7+
Table of Contents:
8+
9+
[Packages](#package)\
10+
[Commands](#cmd)\
11+
[Types](#type)\
12+
[Funcs](#func)\
13+
[Consts](#const)\
14+
[Vars](#var)\
15+
[Syntax](#syntax)\
16+
[Common mistakes and pitfalls](#mistakes)
17+
718
“Doc comments” are comments that appear immediately before top-level package,
819
const, func, type, and var declarations with no intervening newlines.
920
Every exported (capitalized) name should have a doc comment.

0 commit comments

Comments
 (0)