-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
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
Added-API-Documentation-for-RectangularTrimmedSurfacePy.xml and others. #12838
Conversation
kindly review @luzpaz @yorikvanhavre I am working on more files to add API docs for each of them. |
Currently going to through files and making it one to two lines only do we want to keep it more descriptive? |
I would not REMOVE description. The more the better! If it does not format well when rendered to HTML, that's another problem, and we could find good practices for those cases. But the idea here is to be as complete as possible. |
@yorikvanhavre i havent removed anything i dont know why its showing like this https://github.com/FreeCAD/FreeCAD/blob/410d4f9f6acb56cf84f1117dd39a595bcd551f15/src/Mod/Part/App/ShapeFix/ShapeFix_EdgePy.xml |
Currently I copy pasted from here only and added those to docs kindly see. |
Ok this looks good! |
Related to #12547 as a part of improving API documentation for FreeCAD.