add comments to clarify that taxtxf.scm is US-specific

[Geert Janssens]

Op donderdag 26 januari 2017 15:34:22 CET schreef John Ralls:
> > On Jan 26, 2017, at 3:13 PM, D. Hugh Redelmeier <hugh at mimosa.com> wrote:
> > 
> > src/report/locale-specific/us/taxtxf.scm is specific to US tax codes.
> > Add comments to make this clear.
> > 
> > diff --git a/src/report/locale-specific/us/taxtxf.scm
> > b/src/report/locale-specific/us/taxtxf.scm index 7b7e628..e339f2c 100644
> > --- a/src/report/locale-specific/us/taxtxf.scm
> > +++ b/src/report/locale-specific/us/taxtxf.scm
> > @@ -3,9 +3,9 @@
> > ;;
> > ;; updated by  J. Alex Aycinena, July 2008, October 2009
> > ;;
> > -;; This report prints transaction detail and account totals for
> > Tax-related -;; accounts sorted by form/schedule, copy, line and tax
> > code, and exports TXF -;; files for import to TaxCut, TurboTax, etc.
> > +;; This report prints transaction details and account totals for accounts
> > +;; relevant to United States taxes, sorted by form/schedule, copy, line
> > +;; and tax code, and exports TXF files for import to TaxCut, TurboTax,
> > etc. ;;
> > ;; For this to work, the user has to segregate taxable and not taxable
> > ;; income to different accounts, as well as deductible and non-
> 
> Dear Dr. Redelmeier,
> 
> We don't accept patches on the mailing list. Please see
> http://wiki.gnucash.org/wiki/Development#Submitting_Patches for ways that
> you can contribute code.
> 
> In this particular case, though, your patch adds nothing. It's a comment in
> code; such comments are intended solely for developers, and since the path
> to the file includes directories "locale-specific" and "us" it seems pretty
> blindingly obvious that it's for US taxes.
> 
I disagree. While it's only a minor adjustment in the comments, I believe good 
comments are useful as well. We developers tend to consider things obvious 
because we know them for a long time already, but newcomers have to discover a 
lot of implicit knowledge. So if the slight rewording in the comments improves 
this situation for new people, we should include it.

I do agree on the patch submission process of course. In this case however 
since it's such a small patch, I have applied it as is. There's no need to 
resubmit it. For future patches however, please follow the instructions on
http://wiki.gnucash.org/wiki/Development#Submitting_Patches

Thanks for your contribution :)

Geert