Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking: Py3/Qt5 + Uniformity #8

Open
luzpaz opened this issue Jan 5, 2018 · 4 comments
Open

Tracking: Py3/Qt5 + Uniformity #8

luzpaz opened this issue Jan 5, 2018 · 4 comments

Comments

@luzpaz
Copy link
Contributor

luzpaz commented Jan 5, 2018

Reasons:

  • we can run unit tests on them to see if they work
  • they are readable and users can study them
  • inspect/test them for vulnerabilities
  • remove typos
  • have the ability to eventually run them in console mode only (depending on the viability of this)
  • easy to understand attribution to the author(s)
  • clear posting of what the licence is

Macros missing info

Macro Name License Metadata Py3 Qt5
CartoucheFC.py 👎 👎
ViewRotation.FCMacro 👍 👍
FCRotateViewAbsolute.FCMacro 👎 👎
Foto.FCMacro 👎 👎
GenevaWheelGUI.py 👎 👎
ScrewMaker.FCMacro 👎 👎
SolidSweep.FCMacro 👎 👎
apothemBasedPrism.py 👎 👎
makecamera2dview.py 👎 👎
unfoldBox.py 👎 👎
unrollRuledSurface.py 👎 👎
ForceRecompute.FCMacro 👎 👎
HighlightCommon.FCMacro 👍 👍 👍 👍
HighlightDifference.FCMacro 👍 👍 👍 👍
MeasureCircle.FCMacro 👍 👍
MessageBox.FCMacro 👎 👎
SelectVisible.FCMacro 👎 👎
Rectellipse.FCMacro 👎 👎
Airfoil_Import_and_Scale.FCMacro 👎 👎
Draft_Circle_3_Points.FCMacro 👎 👎
Draft_Circle_3_Points_improved.FCMacro 👎 👎
Ellipse-Center 👎 👎
GeodesicDome.FCMacro 👎 👎
HalfHull.FCMacro 👎 👎
HyperbolaCreater.FCMacro 👎 👎
Macro_FCCircularText.FCMacro 👎 👍
MakeCircle3Points.FCMacro 👎 👎
ParabolaCreater.FCMacro 👎 👎
ExportFem.FCMacro 👎 👎
@galou
Copy link
Collaborator

galou commented Jan 5, 2018

Macros already are supposed to have a uniform structure, cf. for example

__Title__="FCCircularText"
__Author__ = "Mario52"
__Version__ = "00.11"
__Date__ = "12/06/2015"
__Comment__ = "This macro creates a text around a cylinder"
__Web__ = "http://forum.freecadweb.org/viewtopic.php?f=3&t=7384"
__Wiki__ = "http://www.freecadweb.org/wiki/Macro_FCCircularText"
__Icon__ = "/usr/lib/freecad/Mod/plugins/icons/FCCircularTextButtom.png"
__IconW__ = "C:/Documents and Settings/YourUserName/Application Data/FreeCAD"
__Help__ = "start the macro and follow the instructions"
__Status__ = "stable"
__Requires__ = "freecad 0.14.3706"
__Communication__ = "http://www.freecadweb.org/wiki/User:Mario52"
. I agree with you that the license information is missing.

Can you please provide an example of how a uniform structure could be used in unit-tests? It sounds interesting.

I don't understand however how a uniform structure could help with typos.

@luzpaz
Copy link
Contributor Author

luzpaz commented Jan 5, 2018

@galou not all of them have all this info. I'll format my idea in regards what else I had in mind

@luzpaz
Copy link
Contributor Author

luzpaz commented Jan 23, 2018

related: #9

@luzpaz luzpaz changed the title Standardize FC macro to have uniform structure and well commented Tracking: Py3/Qt5 + Uniformity Jan 17, 2019
@luzpaz
Copy link
Contributor Author

luzpaz commented Jan 17, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants