User talk:Melwyncarlo

From FreeCAD Documentation

Please improve your Scripting paragraphs

Hi Melwyncarlo,

I see that you are adding similar scripting paragraphs with the same code on many pages:

FreeCADGui.runCommand(...)

This is not very useful for the average Python programmer. Typically they will not use this structure. You are a more advanced Python programmer than I am. So I am convinced you can do better.

For inspiration see here f.e.: Std_New.

Another issue is that you are using several tricks to get a custom layout. Please, please stop doing that. This just creates extra work for editors who then have to go in and fix things. Please read Help:Editing and follow the standards.

--Roy 043 (talk) 01:47, 11 March 2021 (UTC)

Hello Roy, regarding the custom layout (apart from my Macro AeroFoil page), I'm using the basic layout; could you please be more specific as to where I've deviated from the styling norm? Thank you.
Also, the run commands are as it is. It's not about being fancy; those are the simplest copy-paste commands. I've stated that you select the objects, and then run those commands. That's all there is to it. It's like doing a Control+C and Control+V using Python.
I guess I could add the 'addSelection' method to all those run commands to show how to select the objects using Python. But, I had added the 'Selection Methods' link instead, which exemplifies the very same concept. What do you think? Should I add a sort-of mini-tutorial?
- Melwyncarlo 03:30, 11 March 2021 (UTC)
Layout: You make excessive use of blank lines. In every single edit. You should not add <br> at the start of a new paragraph, which you do by default.
Scripting paragraphs: You have copy-pasted this (almost identical) paragraph on 6 pages now (Std_Paste, Std_Copy, Part_ElementCopy, Part_TransformedCopy, Part_RefineShape and Part_SimpleCopy). And I suppose you could continue with many more pages, but please reconsider. A Python programmer will not find this information very useful, especially after reading it 6 times.
--Roy 043 (talk) 14:36, 11 March 2021 (UTC)
Layout - Thank you for notifying me, Roy. I'll stop using the <br> on public documentation.
Scripting - I won't be doing it for any other pages. All those commands were about copy-pasting in different ways. Hence the similarity in code.
- Melwyncarlo 15:30, 11 March 2021 (UTC)

Your edit to Draft_BSpline

Hi Melwyncarlo,

The Draft Python code is a state of transition. Many commands are available under old and new names. This includes the make_bspline command. The new name is 'make_bspline' the old name is 'makeBSpline'. If you look at older versions of this page you will see that the new name was introduced in a recent edit: https://wiki.freecadweb.org/index.php?title=Draft_BSpline&oldid=769819 Your edit: changing back to the old names does not make sense. I have therefore undone it.

--Roy 043 (talk) 21:33, 20 February 2021 (UTC)

Dear Roy,
This is Melwyncarlo from UserTalk. Anyway, I see you have deleted my edit this morning. That command really is faulty. While your reasoning was appropriate, I've added a small addendum notifying other users that the older command works on version 0.18. Note that it also works in 0.19. But, the new command, unfortunately, is not backward compatible. Most users use 0.18, so solely displaying the new command is misleading and confusing. I'd be glad if a note is added.
Thank you very much. Regards,
MFC Boy : the one and only! 12:31, 21 February 2021 (UTC)
Ideally we would have several versions of the wiki. But that is not realistic since we simply lack volunteers willing to invest a serious amount of time. That is why we can and SHOULD only document the coming version. I will leave you addition even though it goes against this. I suppose you will remove it when V0.19 becomes final?
--Roy 043 (talk) 15:39, 22 February 2021 (UTC)