This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author skrah
Recipients Arfrever, Trundle, alex, asvetlov, barry, bfroehle, chris.jerdonek, daniel.urban, david.villa, dmalcolm, eric.smith, ezio.melotti, gregory.p.smith, gvanrossum, jcea, jkloth, larry, mark.dickinson, ncoghlan, pitrou, skrah, v+python
Date 2013-02-13.13:06:28
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1360760789.18.0.617983449453.issue16612@psf.upfronthosting.co.za>
In-reply-to
Content
Here's a proposal for an alternative without parameter docstrings and a
different DSL (see os_stat.c). I guess it's easiest to present my thoughts
in list form.


Changes and rationale:
======================

  Split docstring into function header and rest
  ---------------------------------------------

    - Since the docstrings aren't repeated, less vertical space is used.

    - The main part of the docstring can go into a header file.

    - It's (IMO) easier to compare the generated header (see OS_STAT_HEADER)
      to the specification in the comment.


  More formal DSL
  ---------------

    This is my personal opinion: The existing DSL is fine for a configuration
    file (think .hgrc), but I have trouble with it in the context of a C file.

    Most importantly, I'm unable to take in the required information at a
    single glance.

    So I propose to make the structure of the specification explicit. For
    me the result is more readable. Also, it's already pretty close to a formal
    grammar and can be optionally condensed into single lines.

  Logical grouping
  ----------------

    The preprocessor comment, OS_STAT_HEADER and the os_stat() definition are
    close together and fit on a single screen.
History
Date User Action Args
2013-02-13 13:06:29skrahsetrecipients: + skrah, gvanrossum, barry, gregory.p.smith, jcea, mark.dickinson, ncoghlan, pitrou, larry, eric.smith, jkloth, ezio.melotti, Arfrever, v+python, alex, Trundle, asvetlov, dmalcolm, daniel.urban, chris.jerdonek, bfroehle, david.villa
2013-02-13 13:06:29skrahsetmessageid: <1360760789.18.0.617983449453.issue16612@psf.upfronthosting.co.za>
2013-02-13 13:06:29skrahlinkissue16612 messages
2013-02-13 13:06:28skrahcreate