Rename resolution_parameter to resolution#1015
Conversation
Current Aviator status
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.
|
|
I think we need to temporarily allow the two argument names? https://lifecycle.r-lib.org/articles/communicate.html#renaming-an-argument |
|
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 ah yes you need to run |
| n_iterations = 2, vertex_weights = NULL) { | ||
|
|
||
| if (lifecycle::is_present(resolution_parameter)) { | ||
| lifecycle::deprecate_warn("1.5.0.9006", |
There was a problem hiding this comment.
the version number here should be 2.0.0 (I think?) to go with the next release. it's only confusing for those who'll install the dev version.
There was a problem hiding this comment.
should it be lifecycle::deprecate_soft() for this version?
There was a problem hiding this comment.
the version number here should be
2.0.0(I think?) to go with the next release. it's only confusing for those who'll install the dev version.
Why would this be confusing? Happy to say 2.0.0 here, but when we release any pre-2.0 release with this in it, it would be incorrect, and might be more confusing. (I now realise that I might have targeted the dev branch due to breaking changes, but they're now no longer breaking). Or am I misunderstanding something here?
|
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)? |
b534e83 to
50a625d
Compare
|
Feeling like a complete n00b again! Now get |
|
I've seen this before, igraph also implements a |
|
Can we for now use |
|
@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? |
|
Sure, I'll do that, but what's our rationale for choosing to put |
|
the existence of igraph's own deprecated() remains problematic but I used what we did in another function |
krlmlr
left a comment
There was a problem hiding this comment.
Nice! Good to go from my end.
| check_dots_empty() | ||
|
|
||
| if (lifecycle::is_present(resolution_parameter)) { | ||
| lifecycle::deprecate_soft("1.5.0.9006", |

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.