kicad-developers team mailing list archive

[Henner Zeller <h.zeller@xxxxxxx>]

On 20 October 2015 at 13:49, Henner Zeller <h.zeller@xxxxxxx> wrote:
> On 20 October 2015 at 13:17, Nick Østergaard <oe.nick@xxxxxxxxx> wrote:
>> I think the proposed naming makes sense. I don't think we need to mark
>> it as deprecated, we could just remove it. I have not heard of a lot
>> of users that have discovered the python API, so I think the impact of
>> removing it when we have not yet made the stable release yet is very
>> limited.
>
> Also, it didn't work since JP submitted the patch :) So, yes, we should
> probably rename it immediately with no deprecation period.

Ok, suggested patch here:

https://github.com/hzeller/kicad/compare/master...hzeller:rename-to-protel-extensions.diff

Also includes a call to set this property in the sample script, so
that it is discoverable (with value 'False',
so behavior of existing script doesn't change).

Suggested commit message:
------------
Rename {Set,Get}GerberExtensions() to {Set,Get}GerberProtelExtensions()
in public API.
------------

-h

>
>> But if you wan to have a go with trying out how to warn about
>> deprecated funtions, go ahead. That is just my personal comment on
>> this matter.
>>
>> 2015-10-20 21:39 GMT+02:00 Henner Zeller <h.zeller@xxxxxxx>:
>>> On 20 October 2015 at 11:34, jp charras <jp.charras@xxxxxxxxxx> wrote:
>>>> Le 20/10/2015 06:45, Henner Zeller a écrit :
>>>>> Hi,
>>>>> When setting the SetUseGerberExtensions() in python, the choice was
>>>>> not honored. This is fixing it.
>>>>>
>>>>> Suggested commit message:
>>>>> Fix Plotcontroller to make SetUseGerberExtensions() work as expected.
>>>>>
>>>>> Find patch here:
>>>>> https://github.com/hzeller/kicad/compare/master...hzeller:fix-usegerberextension-scripting.diff
>>>>>
>>>>> -h
>>>>
>>>> Thanks.
>>>>
>>>> I committed a fix derived from your patch, among other fixes in rev 6272.
>>>>
>>>> Can you test it ?
>>>
>>> Yes it works, thanks!
>>>
>>> I noticed that you internally renamed the GetGerberExtension() to
>>> GetGerberProtelExtension(). I think this is a much better name and
>>> less confusing. It also makes it easier to relate the UI (which talks
>>> about Protel).
>>>
>>> I think we should go a step further while it doesn't hurt too much yet:
>>> Given that we haven't released it too much yet to the public (well the
>>> users are probably limited), I think there is a good opportunity _now_
>>> that we also rename the external API for the plot properties:
>>> {Set,Get}UseGerberExtensions() to {Set,Get}UseGerberProtelExtensions().
>>>
>>> The name 'GerberExtensions' is very ambiguous and it is not very clear
>>> what they mean (I would've assumed just *.gbr when reading it), while
>>> ProtelExtension would be very specific and clear.
>>>
>>> (We might keep the {Set,Get}UseGerberExtensions() functions at first
>>> in the Python API, but output a loud warning that the name changed,
>>> and remove it entirely soon).
>>>
>>> WDYT ?
>>> -h
>>>
>>>>
>>>>
>>>> --
>>>> Jean-Pierre CHARRAS
>>>
>>> _______________________________________________
>>> 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