-
Notifications
You must be signed in to change notification settings - Fork 108
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
implemented typedoc documentation #907
Conversation
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #907 +/- ##
==========================================
- Coverage 91.84% 88.40% -3.44%
==========================================
Files 37 62 +25
Lines 4976 8660 +3684
Branches 0 1059 +1059
==========================================
+ Hits 4570 7656 +3086
- Misses 406 1004 +598 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any trouble with signing the CLA? It should be automatic as an individual.
It'd be great if you can take a stab at it - I think you'll probably just have to modify deploy.yml to build that site and put it in another directory under I realized we didn't copy our docs for |
I'm doing GitHub Pages&Workflow for the first time so hopefully I've done it ok. You can check it out...
I see also that methods: getCircularSegments, resetToCircularDefaults, setCircularSegments and setMinCircularEdgeLength doesn't have comments. I will fixed them as well. |
Thanks! The TS |
@elalish I went through the entire doc comments and already fixed a few. Here’s what is still missing:
|
Great, thank you! Are those function definitions missing entirely? Feel free to add them. |
@elalish Yes, the definitions are entirely missing. I could try to add doc comments, but I think it would be better for someone more familiar with the internal logic to do it. |
Addresses #906