could you explain a bit more what do mean?Kunda1 wrote:I listed FEM files that could use a peak at their documentation (list created from a regex) to meet the standards mentioned in the thread.
FEM Python coding standard
Moderator: bernd
Forum rules
and Helpful information for the FEM forum
and Helpful information for the FEM forum
Re: Python coding standard
Re: Python coding standard
Not all the files in the src/Mod/FEM/ are listed in my post. There are some files that start with an underscore that I didn't include.bernd wrote:could you explain a bit more what do mean?Kunda1 wrote:I listed FEM files that could use a peak at their documentation (list created from a regex) to meet the standards mentioned in the thread.
My intention was to illustrate that python variables mentioned previously:
Code: Select all
__Comment__ = 'Imports and scales an Airfoil in the form of a Draft Wire (DWire) or Basic Spline (BSpline)'
__Web__ = 'http://forum.freecadweb.org/viewtopic.php?f=22&t=5554'
__Wiki__ = "http://www.freecadweb.org/wiki/index.php?title=Macro_Airfoil_Import_%26_Scale'
__Icon__ = '/usr/lib/freecad/Mod/plugins/icons/airfoil.png'
__Help__ = 'Start the macro and follow the instructions'
__Author__ = 'quick61'
__Version__ = '2.1'
__Status__ = 'stable'
__Requires__ = 'freecad 0.14.3706'
__Communication__ = 'your email adress or yourgit or something else'
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Re: Python coding standard
That applies to macros only, unless I'm missing something? There is no need to add it to all python files.
Re: Python coding standard
Pardon, I misunderstood. nevertheless there are still doxygen comments that could be added in order to generate doxygen docs for FEMPrzemoF wrote:That applies to macros only, unless I'm missing something? There is no need to add it to all python files.
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Re: Python coding standard
exactly !PrzemoF wrote:That applies to macros only ... There is no need to add it to all python files.
Re: Python coding standard
Could you give more informations?Kunda1 wrote:...nevertheless there are still doxygen comments that could be added in order to generate doxygen docs for FEM
Re: Python coding standard
More of that stuff (from FemTools.py):
It should land here [1], but the link is broken...
[1] http://www.freecadweb.org/api/dd/db6/cl ... Tools.html
Edit: link is OK now, thanks kkremitzki!
http://www.freecadweb.org/api/dc/de2/gr ... 54b64ecdd9
Code: Select all
S> ## Sets mesh color using selected type of results (Sabs by default)
# @param self The python object self
# @param result_type Type of FEM result, allowed are:
# - U1, U2, U3 - deformation
# - Uabs - absolute deformation
# - Sabs - Von Mises stress
# @param limit cutoff value. All values over the limit are treated as equal to the limit. Useful for filtering out hot spots.
def show_result(self, result_type="Sabs", limit=None):
[1] http://www.freecadweb.org/api/dd/db6/cl ... Tools.html
Edit: link is OK now, thanks kkremitzki!
http://www.freecadweb.org/api/dc/de2/gr ... 54b64ecdd9
- kkremitzki
- Veteran
- Posts: 2515
- Joined: Thu Mar 03, 2016 9:52 pm
- Location: Illinois
Re: Python coding standard
I think that may be an issue from my recent rebuild of the API docs; I checked my build folder and that file is there, but it isn't present on the server. I'm investigating now.
- kkremitzki
- Veteran
- Posts: 2515
- Joined: Thu Mar 03, 2016 9:52 pm
- Location: Illinois
Re: Python coding standard
Okay, so there were several missing folders for some reason, but I've compared my build dir and the server and everything seems to match up now. If there are any other issues with the API docs on the site feel free to PM me.
Re: Python coding standard
Please check the doxygen tweeks i've made in https://github.com/luzpaz/FreeCAD/tree/ ... gen-tweeksbernd wrote:Could you give more informations?Kunda1 wrote:...nevertheless there are still doxygen comments that could be added in order to generate doxygen docs for FEM
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs