Skip to content

Made changes to documentation to avoid an error with the upcoming net…#28

Merged
skyebend merged 3 commits intomasterfrom
doc_fix_for_generics
Mar 30, 2026
Merged

Made changes to documentation to avoid an error with the upcoming net…#28
skyebend merged 3 commits intomasterfrom
doc_fix_for_generics

Conversation

@CarterButts
Copy link
Copy Markdown
Contributor

This makes a single set of changes to the usage statement for the network.extensions.Rd file, which uses the \method{} tag to trick R into thinking that the *.active functions are S3 methods. We actually had some of these treated this way before, but more have been rendered generic in the meantime.

@skyebend skyebend merged commit 893267e into master Mar 30, 2026
12 checks passed
@skyebend
Copy link
Copy Markdown
Contributor

@CarterButts when I run cran checks, I see

* checking S3 generic/method consistency ... NOTE
Mismatches for apparent methods not registered:
is.adjacent:
  function(x, vi, vj, na.omit, ...)
is.adjacent.active:
  function(x, vi, vj, onset, terminus, length, at, rule, na.omit,
           active.default)

get.edgeIDs:
  function(x, v, alter, neighborhood, na.omit, ...)
get.edgeIDs.active:
  function(x, v, onset, terminus, length, at, alter, neighborhood,
           rule, na.omit, active.default)

get.edges:
  function(x, v, alter, neighborhood, na.omit, ...)
get.edges.active:
  function(x, v, onset, terminus, length, at, alter, neighborhood,
           rule, na.omit, active.default)

get.neighborhood:
  function(x, v, type, na.omit, ...)
get.neighborhood.active:
  function(x, v, onset, terminus, length, at, type, rule, na.omit,
           active.default)
See section 'Registering S3 methods' in the 'Writing R Extensions'
manual.

which I think is pointing out that ordering of the arguments and "..." don't align, which will probably require a shallow but breaking refactor?

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.

2 participants