-
Notifications
You must be signed in to change notification settings - Fork 8
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
Add documentation to Rcpp interfaces #652
Conversation
Instructions for code reviewerHello reviewer, thanks for taking the time to review this PR!
Checklist
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #652 +/- ##
==========================================
- Coverage 78.88% 78.87% -0.02%
==========================================
Files 36 36
Lines 1975 1974 -1
Branches 141 141
==========================================
- Hits 1558 1557 -1
Misses 374 374
Partials 43 43 ☔ View full report in Codecov by Sentry. |
023632d
to
e0fbfb0
Compare
Thank you, @kellijohnson-NOAA and @Andrea-Havron-NOAA, for your thorough review. I have addressed all of your suggestions. Please let me know if you have any additional feedback. The PR still requires approval from one of you. |
Thank you @Bai-Li-NOAA for all of this documentation. I needed it in dev not main so I unfortunately had to redo the edits in cleanup_dev. The commit message gives you attribution, I hope that is sufficient and I am sorry that I was not able to just merge this branch in. |
Was PR #652 and commit e0fbfb0 but that was based on main and enough has changed that the commit had be redone for dev. There are still some interfaces that are not documented but they can be completed in #662. Thanks to @Bai-Li-NOAA for this commit :) Close #635
What is the feature?
How have you implemented the solution?
inst/include/interface/rcpp/rcpp_interface.hpp
inst/include/interface/rcpp/rcpp_objects/rcpp_data.hpp
andinst/include/interface/rcpp/rcpp_objects/rcpp_population.hpp
Does the PR impact any other area of the project, maybe another repo?