search

igraph / rigraph

igraph R package
https://r.igraph.org
543 stars 201 forks source link

clarify naming scheme in CONTRIBUTING.md #801

Open maelle opened 1 year ago

maelle commented 1 year ago

via #417

szhorvat commented 1 year ago

Can you add a little bit more detail in the description of new issues so those of us who haven't read (or don't remember) every discussion can still follow what's going on?

maelle commented 1 year ago

It might be useful for new contributors to understand how function names were chosen. From the aforementioned issue,

" For graph constructors, for example, I have come across three main types, sample*, make and graphfrom (see a reprex below). However, I have not been able to locate documentation outlining these categories (or categories for other types of functions)."

There are a few answers in https://github.com/igraph/rigraph/issues/417#issuecomment-1072471615

In a comment later there's "The idea is that you have make() for creating graphs in a deterministic way, and sample() for sampling graphs from some ensemble. Both of these functions take a specification of what to construct and a list of optional modifiers"