Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
x/tools/cmd/godoc: support company-specific doc annotations #8586
Google internally runs a godoc server serving docs for the standard library + all of Google $GOPATH (all internal Google Go code). In many cases, we'd like to mention the Google-specific libraries or ways of doing things from the standard library docs. It would be nice if there were a file we could maintain that appended company-specific doc annotations to the standard library on at least: -- packages -- funcs -- types -- specific fields on struct types
That's a possibility. But doing it naively with patch files that would go stale over time as the standard library changes would be a pain, so we'd want to not use diff+patch and an go/*-based AST patcher instead. Once we have that, the godoc hooks aren't much more work and could benefit other companies. Google's not unique in this regard.