FAQ
Hello golang-dev@googlegroups.com (cc: golang-dev@googlegroups.com),

Please take another look.


https://codereview.appspot.com/7220048/

--

Search Discussions

  • R Eklind 87 at Jan 26, 2013 at 6:49 pm
    First I added an example for tar.Writer as well, but removed it in favor
    of the much more concise comment.

    Pros:
    * The concise example captures the important aspects without
    distractions.
    Cons:
    * It isn't checked for compile time errors since it's a comment.

    For reader it makes sense to use a code example, since it will dual as a
    test case.

    Could we make a concise tar.Writer code example or should we stay with
    using the comment example?

    https://codereview.appspot.com/7220048/

    --
  • Minux at Jan 26, 2013 at 7:01 pm

    On Sun, Jan 27, 2013 at 1:05 AM, wrote:

    First I added an example for tar.Writer as well, but removed it in favor
    of the much more concise comment.

    Pros:
    * The concise example captures the important aspects without
    distractions.
    Cons:
    * It isn't checked for compile time errors since it's a comment.

    For reader it makes sense to use a code example, since it will dual as a
    test case.

    Could we make a concise tar.Writer code example or should we stay with
    using the comment example?
    my opinion is that if we can integrate the comments in the example comment
    into the example code, we can get rid of the example comments.

    --

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupgolang-dev @
categoriesgo
postedJan 26, '13 at 6:49p
activeJan 26, '13 at 7:01p
posts3
users2
websitegolang.org

2 users in discussion

R Eklind 87: 2 posts Minux: 1 post

People

Translate

site design / logo © 2022 Grokbase