[SAGA-RG] Python Bindings

[Andre Merzky]

On Wed, Oct 24, 2012 at 9:34 AM, Andre Merzky <andre at merzky.net> wrote:
> Thanks for the comments, Steve, appreciated.  I'll work those in.
>
> About Appendix A: I got some comments from Ole, which I'll am
> currently applying -- I'll circulate an update ASAP.

Attached.

BTW: you (all) should create redmine accounts at redmine.ogf.org, add
an ssh key to your account, join the saga-wg project, and then can
start editing the document yourself :-)

Cheers, Andre.


> Best, Andre.
>
>
> On Wed, Oct 24, 2012 at 8:29 AM, Steve Fisher <dr.s.m.fisher at gmail.com> wrote:
>>> Attached is a first draft of a python binding document for which we
>>> would like to get feedback and comments.
>>
>> Author names are mixed up - some on left and some on right
>>
>> Status: As SAGA -> As a SAGA
>> so-far -> currently defined
>>
>> Copyright notice 2007-2010 -> 2012
>>
>> 2 SAGA Python Bindings last para. I don't think you should refer to
>> these as class prototypes as the notion is not part of python. Instead
>> just say: The explicit python bindings are listed in Appendix A.
>>
>> 2.1 Para 1 sentence 2 ->  While we expect that
>> language bindings will, in general, follow that hierarchy for Python
>> it is not useful to do so.
>>
>> Omit 2.1 para 3
>>
>> 2.1.1 CAN -> MAY
>>
>> 2.1.2 Omit last two sentences
>>
>> 2.1.2 wrong kind of opening quote before "namespace" - this appears
>> elsewhere too - a global edit with a regexp should find them
>>
>> 2.2 as lightly ->  a slightly
>>
>> 2.2 add to text before bullet points:   "they"
>>
>> 2.2 The reference for Python naming conventions is:
>> http://www.python.org/dev/peps/pep-0008
>>
>> 2.4  -> The SAGA API includes a number of enums, which are usually
>> related to classes
>> within a specifi c API package. Python does not have a native notion
>> of enums. We follow the recommendation in pep-0008 to define constants
>> on a module level,  written in all capital letters with underscores
>> separating words.
>>
>> 2.5 Omit this section - it will be hard to get right and will just
>> cause confusion
>>
>> 4.4 2007 -> 2012
>>
>> Appendix A - This should start with an explananation of how to
>> interpret what follows
>>
>> I will send comments on the contents of Appendix A as a separate email
>>
>> Steve
>
>
>
> --
> Nothing is really difficult...



-- 
Nothing is really difficult...
-------------- next part --------------
A non-text attachment was scrubbed...
Name: saga_bindings_python.pdf
Type: application/pdf
Size: 192254 bytes
Desc: not available
URL: <http://www.ogf.org/pipermail/saga-rg/attachments/20121024/916d429b/attachment-0001.pdf>