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

Added-API-Documentation-for-RectangularTrimmedSurfacePy.xml and others. #12838

Merged
merged 6 commits into from
Mar 13, 2024

Conversation

Ovalelephant35
Copy link
Contributor

Related to #12547 as a part of improving API documentation for FreeCAD.

@github-actions github-actions bot added the WB Part Related to the Part Workbench label Mar 10, 2024
@Ovalelephant35 Ovalelephant35 changed the title Added-API-Documentation-for-RectangularTrimmedSurfacePy.xml Added-API-Documentation-for-RectangularTrimmedSurfacePy.xml and others. Mar 10, 2024
@Ovalelephant35
Copy link
Contributor Author

Ovalelephant35 commented Mar 10, 2024

kindly review @luzpaz @yorikvanhavre I am working on more files to add API docs for each of them.
Also in https://github.com/FreeCAD/FreeCAD/blob/410d4f9f6acb56cf84f1117dd39a595bcd551f15/src/Mod/Part/App/ShapeFix/ShapeFix_EdgePy.xml we can see that it is missing API documentation seems to be some issue here?

@Ovalelephant35
Copy link
Contributor Author

Currently going to through files and making it one to two lines only do we want to keep it more descriptive?

@yorikvanhavre
Copy link
Member

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.

@Ovalelephant35
Copy link
Contributor Author

Ovalelephant35 commented Mar 11, 2024

@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
I added to this can you take a look so that i can make changes asap!!!
The above link is the file i changed.

@Ovalelephant35
Copy link
Contributor Author

Currently I copy pasted from here only and added those to docs kindly see.

@yorikvanhavre
Copy link
Member

Ok this looks good!

@yorikvanhavre yorikvanhavre merged commit 69a3371 into FreeCAD:main Mar 13, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
WB Part Related to the Part Workbench
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants