public inbox for frysk@sourceware.org
 help / color / mirror / Atom feed
From: Mark Wielaard <mark@klomp.org>
To: Tom Tromey <tromey@redhat.com>
Cc: Frysk List <frysk@sourceware.org>
Subject: Re: Patch: word-wrapping for 'help' output
Date: Sun, 02 Mar 2008 12:34:00 -0000	[thread overview]
Message-ID: <1204461251.8622.12.camel@localhost.localdomain> (raw)
In-Reply-To: <m3d4qef2kz.fsf@fleche.redhat.com>

Hi Tom,

On Sat, 2008-03-01 at 16:26 -0700, Tom Tromey wrote:
> Mark> This could use a method description.
> 
> You'll forgive me for assuming that the frysk style was not to write
> javadoc.

Documentation is really important. Especially later on when you look bad
at code you might not have written yourself and try to figure out what
and why it actually works. In this case I should probably have added it
myself since I was reviewing the code anyway. Sorry I was a bit lazy.
And thanks for picking it up!

> Here's an add-on patch that adds javadoc.  Let me know what you think.
> I guess I should learn git enough to supply consolidated patches.

This looks great! Don't worry too much about consolidating the patches.
I'll commit them separately on top of each other and then push them in
one go. It only really matter if the intermediate commits are bad (so
you cannot bisect through them when searching when something broke).
Some more git info and references can be found at:
http://sourceware.org/frysk/build/git-fu.html

> b/frysk-core/frysk/hpd/ChangeLog:
> 2008-03-01  Tom Tromey  <tromey@redhat.com>
> 
> 	* CLI.java (getWordWrapWriter): Document.
> 
> b/frysk-core/frysk/util/ChangeLog:
> 2008-03-01  Tom Tromey  <tromey@redhat.com>
> 
> 	* WordWrapWriter.java: Document.

Committed and will be pushed soon.

Thanks,

Mark

  reply	other threads:[~2008-03-02 12:34 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-29 21:18 Tom Tromey
2008-03-01 22:04 ` Mark Wielaard
2008-03-02  0:17   ` Tom Tromey
2008-03-02 12:34     ` Mark Wielaard [this message]
2008-03-02  0:42   ` Tom Tromey
2008-03-02 12:48     ` Mark Wielaard
2008-03-02 16:10       ` Tom Tromey
2008-03-02 22:05         ` Mark Wielaard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1204461251.8622.12.camel@localhost.localdomain \
    --to=mark@klomp.org \
    --cc=frysk@sourceware.org \
    --cc=tromey@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).