commit | 11440451b27d9eddd85c7f3e570ab8af6033da23 | [log] [tgz] |
---|---|---|
author | Todd Wang <toddw@google.com> | Fri May 29 18:05:29 2015 -0700 |
committer | Todd Wang <toddw@google.com> | Fri May 29 18:05:33 2015 -0700 |
tree | cf3bba6c424a5ea9428780f98a5e3d54802bc621 | |
parent | f37f7b2e32c587d6f97331bb73671091a254b18c [diff] |
ref: Add short description to godoc headers. The auto-generated doc.go file for cmdline tools is formatted specially so that godoc will interpret each command as a header, which gets automatically linked to a table of contents. This change adds the short description from each command or help topic, to make the TOC more useful. Note that godoc has heurisitics for what it considers an appropriate header; e.g. if the line contains certain puncutation it won't be extracted as a header. For these cases we fall back and only use the command path, since it's better to have a less descriptive header than to have no header at all. Also added LineWriter.ForceVerbatim, which lets us force verbatim mode. This is used to ensure the header line we generate isn't wrapped into more than one line. MultiPart: 3/3 Change-Id: I7f797d2f3945e3b1ff55bc513a9a8bd2d98a5e8c
This repository contains a reference implementation of the Vanadium APIs.
Unlike the APIs in https://github.com/vanadium/go.v23, which promises to provide backward compatibility this repository makes no such promises.