perspective
perspective copied to clipboard
finos
Aggregation documentation
Support Question
Some of the aggregation names are very obscure. Is it possible to add documentation that explains them? Even one sentence per aggregation would do wonders. I know documentation is currently being improved gradually, but this seems to be one area that is left untouched.
Hey :) I would love to contribute to the documentation for perspective. Is the issue still up (and no one is already on it already) can I take this up?
No one has volunteered! We track what we're currently working on on Projects, and Issues via the Assignees panel (on your right sidebar in current Github layout).
Markdown changes to the documentation should be pretty straightforward. I think the best place to add these would either be a new top-level page aggregations.md, which we can add to the API section of the documentation. You can take a look at the existing docs pages and copy the template.
It would be nice to also document these in the code somewhere, though this is a more complex project (the enums are only defined currently in C++). This would ultimately just involve copy/pasting the prose descriptions into the code in tandem with doc generator support for where-ever we put it, regardless.
@texodus can you please give some examples of aggregation names in the documentation. I am not exactly getting what we are expecting out of this issue?
I would also find this very helpful. Have been trying to read the code to figure out what aggregations like "any" or "count" mean exactly (e.g. how do they treat missing values?). A one sentence description of each agg function in the docs somewhere would be great!
