FAQ
https://codereview.appspot.com/7064052/diff/5001/doc/articles/godoc_documenting_go_code.html
File doc/articles/godoc_documenting_go_code.html (right):

https://codereview.appspot.com/7064052/diff/5001/doc/articles/godoc_documenting_go_code.html#newcode95
doc/articles/godoc_documenting_go_code.html:95: <a
href="/pkg/testing/#pkg-overview"><code>testing</code></a> package's
naming
this paragraph is oddly placed.

it might be better as a footnote at the bottom of the document

https://codereview.appspot.com/7064052/diff/5001/doc/articles/godoc_documenting_go_code.html#newcode96
doc/articles/godoc_documenting_go_code.html:96: conventions and tries to
present them appropriately.
"tries to"!? It shouldn't just try!

https://codereview.appspot.com/7064052/

Search Discussions

  • Mdempsky at Jan 8, 2013 at 8:25 am
    https://codereview.appspot.com/7064052/diff/5001/doc/articles/godoc_documenting_go_code.html
    File doc/articles/godoc_documenting_go_code.html (right):

    https://codereview.appspot.com/7064052/diff/5001/doc/articles/godoc_documenting_go_code.html#newcode95
    doc/articles/godoc_documenting_go_code.html:95: <a
    href="/pkg/testing/#pkg-overview"><code>testing</code></a> package's
    naming
    On 2013/01/08 05:44:41, adg wrote:
    this paragraph is oddly placed.
    Honestly, anywhere I considered putting it seemed odd. For what it's
    worth, I put it here because the structure of the document seems to be:

    - general information about godoc
    - more detailed information about how godoc decides which comments to
    display
    - details about general package documentation
    - details about executable documentation
    - details about HTML formatting
    - closing paragraph that users can add godoc comments to their own
    code too

    I picked the spot I did (i.e., between "package documentation" and
    "executable documentation") because example code seemed most relevant to
    writing packages that will be reused by others.

    I'm not strongly opinionated though.

    https://codereview.appspot.com/7064052/diff/5001/doc/articles/godoc_documenting_go_code.html#newcode96
    doc/articles/godoc_documenting_go_code.html:96: conventions and tries to
    present them appropriately.
    On 2013/01/08 05:44:41, adg wrote:
    "tries to"!? It shouldn't just try!
    Well, it doesn't always succeed. ;) E.g., examples aren't displayed on
    the console, and some examples don't actually work when run in the
    playground: http://golang.org/pkg/time/#After

    But point taken, I'll s/tries to present/presents/.

    https://codereview.appspot.com/7064052/
  • Mdempsky at Jan 8, 2013 at 8:38 am
    Hello iant@golang.org, adg@golang.org (cc: golang-dev@googlegroups.com),

    Please take another look.


    https://codereview.appspot.com/7064052/

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupgolang-dev @
categoriesgo
postedJan 8, '13 at 5:44a
activeJan 8, '13 at 8:38a
posts3
users2
websitegolang.org

2 users in discussion

Mdempsky: 2 posts Adg: 1 post

People

Translate

site design / logo © 2022 Grokbase