fix: resolve roxygen2 warnings#2692
Merged
Merged
Conversation
With roxygenize() no longer swallowing errors, roxygen2 now reports several real issues: - @Aliases tags must be a single line (cohesive.blocks.R, layout.R); collapse the wrapped tags. - Several S3 methods had only a @method tag and were never registered in NAMESPACE because roxygen never ran successfully. Add @export so they are registered: as.data.frame/[/[<-.igraphSDF and as.dendrogram.igraphHRG (matching as.dendrogram.communities).
Contributor
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if f638852 is merged into main:
|
schochastics
changed the title
Contributor
|
Danke! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix #2641
Summary
Follow-up to #2690 / #2679. Now that
roxygenize()no longer swallows errors and the docs are actually regenerated in CI, roxygen2 surfaces several real issues that were previously hidden. This fixes them at the source (roxygen comments only — Rd/NAMESPACE are regenerated in CI).Fixes
@aliasesmust be a single line (roxygen2 8.x): collapse the wrapped tags incohesive.blocks.Randlayout.R.@methodtag and were never registered inNAMESPACE(roxygen never ran successfully before). Added@exportso they are registered viaS3method():as.data.frame.igraphSDF,[.igraphSDF,[<-.igraphSDFas.dendrogram.igraphHRG(mirrors the already-exportedas.dendrogram.communities)Not changed
The
@details refers to un-installed package apemessage is a local-only artifact —apeis aSuggestsand is installed in CI (deps::.pulls the root package's soft deps), where[ape::as.phylo()]resolves. Rewriting the valid cross-reference would be wrong.