Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change default value cut.prob to NULL in motif finding functions #1570

Open
szhorvat opened this issue Nov 3, 2024 · 2 comments · May be fixed by #1602 or #1574
Open

Change default value cut.prob to NULL in motif finding functions #1570

szhorvat opened this issue Nov 3, 2024 · 2 comments · May be fixed by #1602 or #1574
Assignees
@maelle
Labels
lifecycle Deprecating old APIs

Comments

@szhorvat
Copy link
Member

szhorvat commented Nov 3, 2024

The default value for the cut.prob parameter of motif finding functions should have a default value of NULL instead of rep(0, size). The documentation should be changed to say that NULL indicates that "no cuts are made".

This does not change behaviour. It makes use of a corresponding change in the C core (igraph/igraph#2555) and simplifies things in the long term.

Can you have a look at this @maelle, since you are doing cleanup refactoring anyway?
@maelle
Copy link
Contributor

maelle commented Nov 5, 2024

My first thought: is this also the opportunity to rename the parameter to something snake case. 😅

@maelle maelle added the lifecycle Deprecating old APIs label Nov 5, 2024
@maelle maelle self-assigned this Nov 5, 2024
@szhorvat
Copy link
Member Author

szhorvat commented Nov 5, 2024

The majority of parameter names use . instead of _ at the moment so I suggest not doing this at this point. The code generator auto-transforms _ -> . right now in parameter names (not function names).

Note that what I suggest here is not breaking .

@maelle maelle linked a pull request Nov 7, 2024 that will close this issue
Draft
@maelle maelle linked a pull request Nov 28, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@maelle maelle

Labels
lifecycle Deprecating old APIs
Projects
None yet
Milestone
No milestone
2 participants
@szhorvat @maelle