20 Sep
2017
20 Sep
'17
10:25 a.m.
On Sep 19, 2017, at 11:43 PM, Peter Jeremy
<peter(a)rulingia.com> wrote:
On 2017-Sep-19 18:09:27 -0700, Lyndon Nerenberg <lyndon(a)orthanc.ca> wrote:
You don't even have to install a godoc server unless you want
a web interface. You can just type for example
go doc regexp -- get top level regexp documentation
go doc regexp/syntax -- regexp syntax
go doc regexp.MustCompile -- help on just one exported function
go doc regexp.Regexp -- help on exported type Regexp and a list of its methods
Often this is quite handy. I just open 6 to 8 windows in acme &
can have help text for various things, all accessible at once.
In contrast browsers feel quite clunky. They waste a lot of white
space and yet you have to scroll even on a HDMI+ rez display!
*Please* write your documentation in a way that
allows you to generate
(useful, readable!) PDF documents that I can download for offline viewing.
Believe it or not, I don't haul along a 300 mile cat-5 cable when I go
sailing. I still like to write code on the boat. So much for Go :-P
One of the really nice things about Go is that all the library source code
and documentatin is installed by default and you can run a local instance of
the documentation server on your laptop (or whatever). Likewise, the
specification is one HTML page - if you really want, you could convert that
to PDF but having all the hyperlinks is really handy. (I haven't tried
running a local copy of the playground but that should be possible as well).