Skip to content

Improve roxygen2 documentation#6

Merged
lcgodoy merged 3 commits intodevfrom
doc-improvements-1622105888031150025
Jan 5, 2026
Merged

Improve roxygen2 documentation#6
lcgodoy merged 3 commits intodevfrom
doc-improvements-1622105888031150025

Conversation

@google-labs-jules
Copy link
Contributor

This PR improves the roxygen2 documentation for several key functions in the package, including fit_drm, fit_sdm, predict_drm, predict_sdm, and helper functions in utils.R and make-data.R. It addresses formatting issues, typos, duplicate descriptions, and clarifies return values.


PR created automatically by Jules for task 1622105888031150025 started by @lcgodoy

lcgodoy and others added 2 commits November 17, 2025 12:16
- Correct formatting in `@return` and `@param` sections across multiple files.
- Fix typos and grammar errors in parameter descriptions (e.g., `make_data.R`, `utils.R`).
- Remove duplicate or incorrect `@description` blocks (e.g., in `predict_sdm`).
- Clarify return values, specifically identifying `CmdStanGQ` objects.
- Fix copy-paste errors in `fit_sdm` return value documentation.
- Update author tag typo in `utils.R`.
@google-labs-jules
Copy link
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@lcgodoy lcgodoy changed the base branch from main to dev January 5, 2026 23:15
@lcgodoy lcgodoy self-requested a review January 5, 2026 23:16
@lcgodoy lcgodoy merged commit da2b962 into dev Jan 5, 2026
1 check failed
@lcgodoy lcgodoy deleted the doc-improvements-1622105888031150025 branch January 5, 2026 23:29
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.

1 participant