Skip to content

Fixes feedback from CRAN#85

Merged
averissimo merged 9 commits into
release-candidate-v0.1.0from
cran_feedback
May 14, 2026
Merged

Fixes feedback from CRAN#85
averissimo merged 9 commits into
release-candidate-v0.1.0from
cran_feedback

Conversation

@averissimo
Copy link
Copy Markdown
Contributor

Pull Request

Thanks,

Please add \value to .Rd files regarding exported methods and explain
the functions results in the documentation. Please write about the
structure of the output (class) and also what the output means. (If a
function does not return a value, please document that too, e.g.
\value{No return value, called for side effects} or similar)
For more details:
https://contributor.r-project.org/cran-cookbook/docs_issues.html#missing-value-tags-in-.rd-files

-> Missing Rd-tags:
as.picks.Rd: \value
dot-is_delayed.Rd: \value
picks.Rd: \value
ranged.Rd: \value
tidyselectors.Rd: \value
tm_merge.Rd: \value

Please fix and resubmit.

Best,
Konstanze Lauseker (she/her)

@averissimo averissimo changed the title docs: adds return param Fixes feedback from CRAN May 13, 2026
Copy link
Copy Markdown
Contributor

@osenan osenan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM:

Do you know if we also have to add return tag to internal functions we have many with internal documentation but without return tag in:

  • call_utils.R
  • module_picks.R
  • ui_containers.R

Thank you

@averissimo
Copy link
Copy Markdown
Contributor Author

@osenan awesome, I've updated with those as well.

Copy link
Copy Markdown
Contributor

@osenan osenan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! You can merge, just be sure that this small change is correct.

Comment thread R/module_picks.R Outdated
logger::log_debug(log)
rv(value)
}
rv
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previously this function was returning the value, now the reactiveValue

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really, changing the reactiveVal outputs TRUE (or NULL if condition is not met)

No point in changing the behavior, I'll revert this and change doc accordingly

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@osenan check the latest changes

@osenan osenan self-assigned this May 13, 2026
@llrs-roche
Copy link
Copy Markdown
Contributor

Do you know if we also have to add return tag to internal functions we have many with internal documentation but without return tag in:

I recommend to run devtools::check_doc_fields() and fix whatever it is reported. I think it is usually requested too, as they are on the manuals even if not indexed.

Comment thread R/module_picks.R
@averissimo
Copy link
Copy Markdown
Contributor Author

Added missing examples of exported functions identified by the wonderful function that @llrs-roche referenced

All the remaining missing @examples are from non-exported functions

Copy link
Copy Markdown
Contributor

@osenan osenan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for the changes. I saw errors, notes and warnings if I run devtools::check. I also see missing doc fields

Image Please fix it and before next review run manually devtools document(), check and check_doc_fields so we are more confident it will pass all checks.

Comment thread R/module_picks.R Outdated
Comment thread R/interaction.R Outdated
Comment thread R/module_picks.R Outdated
@averissimo
Copy link
Copy Markdown
Contributor Author

averissimo commented May 14, 2026

@osenan those are all non-exported functions.

AFAIK CRAN doesn't like that, I can check the docs for the quote

@osenan
Copy link
Copy Markdown
Contributor

osenan commented May 14, 2026

Ok, but warnings and errors should be addressed, they are actually the only suggestions

averissimo and others added 2 commits May 14, 2026 16:12
Co-authored-by: Oriol Senan  <35930244+osenan@users.noreply.github.com>
Co-authored-by: André Veríssimo <211358+averissimo@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@osenan osenan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@averissimo averissimo merged commit 5cbbed2 into release-candidate-v0.1.0 May 14, 2026
1 check passed
@averissimo averissimo deleted the cran_feedback branch May 14, 2026 16:30
@github-actions github-actions Bot locked and limited conversation to collaborators May 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants