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

Add documentation to Rcpp interfaces #652

Closed
wants to merge 1 commit into from

Conversation

Bai-Li-NOAA
Copy link
Contributor

What is the feature?

> FIMS:::AgeComp
C++ class 'AgeComp' <00000171049c3560>
Constructors:
    AgeComp(int, int)
        docstring : The first dimension of the data is the maximum year, and the second dimension is the maximum age.

Fields: 
    Rcpp::Vector<14, Rcpp::PreserveStorage> age_comp_data
        docstring : The age composition data.

Methods: 
     unsigned int get_id()  
           docstring : Get the ID of the interface object, No inputs are required.

How have you implemented the solution?

  • Added documentation to inst/include/interface/rcpp/rcpp_interface.hpp
  • Fixed minor documentation typos in inst/include/interface/rcpp/rcpp_objects/rcpp_data.hpp and inst/include/interface/rcpp/rcpp_objects/rcpp_population.hpp

Does the PR impact any other area of the project, maybe another repo?

  • No.

@Bai-Li-NOAA Bai-Li-NOAA linked an issue Jul 24, 2024 that may be closed by this pull request
Copy link
Contributor

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

Copy link

codecov bot commented Jul 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.87%. Comparing base (39d0743) to head (e0fbfb0).
Report is 3 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@Bai-Li-NOAA Bai-Li-NOAA force-pushed the document-rcpp-interfaces branch from 023632d to e0fbfb0 Compare July 26, 2024 16:51
@Bai-Li-NOAA
Copy link
Contributor Author

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.

@kellijohnson-NOAA
Copy link
Contributor

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.

kellijohnson-NOAA added a commit that referenced this pull request Sep 1, 2024
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
@kellijohnson-NOAA kellijohnson-NOAA deleted the document-rcpp-interfaces branch December 31, 2024 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Developer Issue]: Documenting things using Rcpp or C++
3 participants