rigraph icon indicating copy to clipboard operation
rigraph copied to clipboard

Rename resolution_parameter to resolution

Open vtraag opened this issue 2 years ago • 10 comments

Fixes #883. I've only updated the R file and the test, all the rest should follow automatically, if my understanding is correct? If more is needed, let me know.

vtraag avatar Dec 19 '23 09:12 vtraag

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes. Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged manually (without Aviator). Merging manually can negatively impact the performance of the queue. Consider using Aviator next time.


See the real-time status of this PR on the Aviator webapp.
Use the Aviator Chrome Extension to see the status of your PR within GitHub.

aviator-app[bot] avatar Dec 19 '23 09:12 aviator-app[bot]

I think we need to temporarily allow the two argument names? https://lifecycle.r-lib.org/articles/communicate.html#renaming-an-argument

maelle avatar Dec 19 '23 14:12 maelle

Sure, sounds like a good idea!

I'm not entirely sure why the checks fail. Are the examples from the documentation not updated before being run or something? Should I run something in order to trigger an update of the docs?

vtraag avatar Dec 19 '23 15:12 vtraag

@vtraag ah yes you need to run devtools::document() to update the Rd files (the manual pages).

maelle avatar Dec 19 '23 15:12 maelle

@vtraag ah yes you need to run devtools::document() to update the Rd files (the manual pages).

Unfortunately can't do that now, apparently have to install something still, but R mirrors seem to be down:

image

vtraag avatar Dec 19 '23 15:12 vtraag

I've now updated the docs.

By the way, I'm not sure how the deprecation should be dealt with in the docs? Should the old argument still be there, saying it's deprecated, and point to the new argument? Are there any defaults for this in R (sorry, I almost never work in R)?

vtraag avatar Dec 19 '23 20:12 vtraag

Feeling like a complete n00b again! Now get Error: Error in deprecated() : argument "old" is missing, with no default in the CI. According to the docs deprecated doesn't have any arguments: https://lifecycle.r-lib.org/reference/deprecated.html. So I'm not sure what the error means or what can be done about it. Any suggestions @maelle ?

vtraag avatar Jan 12 '24 15:01 vtraag

I've seen this before, igraph also implements a deprecated() function. Can we rename (in a separate PR), to avoid this kind of confusion?

krlmlr avatar Jan 13 '24 15:01 krlmlr

Can we for now use lifecycle::deprecated ? What is the igraph::deprecated function used for, and do we need to retain it at all? (Separate PR and/or issue might be good indeed).

vtraag avatar Jan 13 '24 23:01 vtraag

@vtraag the igraph deprecated() function will soon be removed, by #1014 and #1104 which aren't ready yet (and thanks to other commits).

maelle avatar Jan 15 '24 12:01 maelle

@maelle: I forgot why this is assigned to me. We probably want to add an ellipsis after the second argument and run revdepchecks. Can you please help with the ellipsis?

krlmlr avatar Apr 13 '24 17:04 krlmlr

Sure, I'll do that, but what's our rationale for choosing to put check_dots_empty() in auto-generated vs wrapper code?

maelle avatar May 14 '24 11:05 maelle

the existence of igraph's own deprecated() remains problematic but I used what we did in another function

maelle avatar May 14 '24 12:05 maelle