You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The functionality in get_groups combined with groupby is very powerful and clever. However, the documentation is a bit lacking.
I understand how these capabilities are used in PowerAnalytics.jl. Let's take an example where you want to sum active_power for generators grouped by fuel type. We need this functionality merged ASAP. 100% agree and let's do it.
If this is to be a public interface that we expect users to use, the documentation needs improvement. At minimum, there should be a complete workflow example. Common questions will be, "what is the difference between groupby = :each and groupby = :all? What is an example of a function that should be passed? This leaves me with three conflicting opinions. (1) Leave it alone with the understanding that very few people will ever consider this. (2) Don't export this method. (3) Go all in and give complete documentation.
Once a power user understands what's going on here, they are likely to ask why we did all this. They might say, why not rely on existing packages, like this example
groupby = :each
andgroupby = :all
? What is an example of a function that should be passed? This leaves me with three conflicting opinions. (1) Leave it alone with the understanding that very few people will ever consider this. (2) Don't export this method. (3) Go all in and give complete documentation.If we go all in on documentation, we should anticipate this question and address it.
Originally posted by @daniel-thom in #1197 (comment)
The text was updated successfully, but these errors were encountered: