kicad-developers team mailing list archive

[Wayne Stambaugh <stambaughw@xxxxxxxxx>]

Simon,

I committed your patch to the master branch.  I cleaned up the
formatting, removed trailing whitespace, and added a table of contents.
If I broke any formatting, please let me know.  In the future, please
limit you column width to 80 or 100 for markdown files.  It's also a
good idea to add a table of contents an header links for longer
documents to ease navigation.  Thank you for your contribution to KiCad.

Cheers,

Wayne.

On 6/27/2017 5:15 PM, Simon Küppers wrote:
> Find the patch attached in case there are no objections from someone else.
> 
> Best Regards
> Simon
> 
> Am 2017-06-27 21:49, schrieb Wayne Stambaugh:
>> This looks good.  Anyone else find any issues with it?  You do not need
>> to change the Doxygen configuration files.  Someone modified them to use
>> all *.md files in the appropriate search paths.  Please post the patch
>> created by git format-patch and post it as an attachment and I will
>> commit it if no one objects.
>>
>> On 6/18/2017 11:25 AM, Simon Küppers wrote:
>>> I made some adjustments to the documentations.
>>> https://github.com/skuep/kicad-source-mirror/blob/devel/Documentation/development/pcbnew-plugins.md
>>>
>>>
>>> I did not write something about adding paths to the python runtime
>>> environment since I don't use this feature (and don't want to ;-))
>>> because I don't feel comfortable getting so close the the Python
>>> internals. Also you have to be somewhat careful to not break
>>> cross-platform support.
>>>
>>> The PEP 8 was not particularly helpful, I agree. I changed it.
>>>
>>> How do I add the document to the "Doxygen configuration file" (the
>>> Doxyfile?). From what I know of Doxygen, it pulls all files that match
>>> the given file extensions (which include *.md).
>>>
>>> PS: English capitalization and comma rules always give me a headache,
>>> sorry! ;-) Anyway, keep the comments incoming.
>>>
>>> Best Regards
>>> Simon
>>>
>>> Am 17.06.2017 um 15:41 schrieb Wayne Stambaugh:
>>>> Simon,
>>>>
>>>> Please be patient.  I know things have been a bit slow on the mailing
>>>> list recently.  This is not that unusual in the summer as developers
>>>> are
>>>> on vacation or busy doing other things.
>>>>
>>>> I took a look at your document and have the following comments:
>>>>
>>>> Avoid referring to the Python plugin as a new feature.  This will
>>>> eliminate the need to go back and change the document when it no longer
>>>> is a new feature.  The Python plugin support has been around for a few
>>>> years.  Only the action plugin in support is new.
>>>>
>>>> The title should read "Python Plugin Development for Pcbnew" using
>>>> title
>>>> capitalization as shown.  It's common to use title capitalization for
>>>> all section titles.  All the section titles in your document use
>>>> sentence capitalization.
>>>>
>>>> "Pcbnew" should always be capitalized since it is a proper noun and is
>>>> the official name.
>>>>
>>>> PEP 8 is the Python coding standard.  This doesn't seem like it's
>>>> related to Python packaging.  Are you sure this is the correct PEP?
>>>>
>>>> It might not be a bad idea to let developers know that additional paths
>>>> can be added to the Python runtime environment when designing complex
>>>> plugins using the sys.path or the equally handy PYTHONPATH environment
>>>> variable.  This handy Python feature is often overlooked by developers
>>>> new to Python.
>>>>
>>>> Your patch does not add the new document to the Doxygen configuration
>>>> file so it will not get added to to the developers documentation.
>>>>
>>>> Would someone with more knowledge about the Pcbnew Python plugin
>>>> support
>>>> verify that this information is correct?  It looks fine to me but I'm
>>>> not completely familiar with the new action plugin support.
>>>>
>>>> Cheers,
>>>>
>>>> Wayne
>>>>
>>>> On 6/17/2017 5:59 AM, Simon Küppers wrote:
>>>>> Since there hasn't been any followup, attached is the patch.
>>>>>
>>>>> Best Regards!
>>>>>
>>>>>
>>>>> _______________________________________________
>>>>> Mailing list: https://launchpad.net/~kicad-developers
>>>>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>>>>> Unsubscribe : https://launchpad.net/~kicad-developers
>>>>> More help   : https://help.launchpad.net/ListHelp
>>>>>
>>>>
>>>>
>>>> _______________________________________________
>>>> Mailing list: https://launchpad.net/~kicad-developers
>>>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>>>> Unsubscribe : https://launchpad.net/~kicad-developers
>>>> More help   : https://help.launchpad.net/ListHelp
>>>>
>>>
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~kicad-developers
>>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~kicad-developers
>>> More help   : https://help.launchpad.net/ListHelp
>>>
>>
>> _______________________________________________
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
> 
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
>