feat: sample_chung_lu()

[szhorvat]

Closes #1369.

Translating the documentation was a lot of work. If there are minor stylistic issues to fix, I'd appreciate it if someone could take this over and fix those. Let's try to have this in the next release please.

[aviator-app]

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 using Aviator.

---

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.

[krlmlr]

Thanks! I glimpsed over the text and the autogenerated code, looks good. Would you add the ellipsis?

[krlmlr]

Do we want this?

Suggested change

	chung_lu_game_impl <- function(out.weights, in.weights=NULL, loops=TRUE, variant=c("original", "maxent", "nr")) {
	chung_lu_game_impl <- function(out.weights, ..., in.weights=NULL, loops=TRUE, variant=c("original", "maxent", "nr")) {

[szhorvat]

No, definitely not. The ellipsis should come after in.weights, not before. Out- and in-weights go together and users shouldn't be forced to spell out the name of these parameters.

[krlmlr]

Not sure if we should forward or alias. Both have advantages.

[szhorvat]

Would you add the ellipsis?

I think the ellipsis makes sense like this:

function(out.weights, in.weights=NULL, ..., loops=TRUE, variant=c("original", "maxent", "nr"))

I can add it, but I need some help here. Notice that there are two functions on the same doc page (as with all sample_ and make_ functions), and one of them already has a ..., which is already documented:

Is this going to be an issue? What should I do here? Just keep the docs as they are even though it is slightly confusing?

[szhorvat]

@krlmlr I pushed a commit adding the ellipsis to illustrate. This is what the docs look like now, with the ... moved to a confusing 3rd place. In reality the doc text refers to chung_lu(), not to sample_chung_lu(). Let me know how to proceed.

[krlmlr]

Good point. I pushed a proposal, it's a bit of work but solves the issue at hand and also offers autocomplete for chung_lu() .

How is chung_lu() used anyway?

[szhorvat]

How is chung_lu() used anyway?

It's used with sample_(). The make_() doc page has examples. One can add constructor modifiers: https://r.igraph.org/reference/index.html#constructor-modifiers I don't have much direct experience with using these.

[szhorvat]

I think this is done and ready to go, right?

[krlmlr]

Thanks!

[szhorvat]

Thanks @krlmlr !

[szhorvat]

I forgot to mark it as experimental, which is necessary since it's experimental in C. I pushed this change to main directly: 4a3983d Are you okay with this?

[krlmlr]

Works for me, as long as the main branch stays green 🙃

[szhorvat]

OK, I'll continue to make simple doc changes on main, for efficiency.