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.

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

Improve View docs #455

Open
t92549 opened this issue Dec 18, 2023 · 0 comments
Open

Improve View docs #455

t92549 opened this issue Dec 18, 2023 · 0 comments
Labels
enhancement Improvement to an existing part of the documentation
Milestone

Comments

@t92549
Copy link
Contributor

t92549 commented Dec 18, 2023

The filtering documentation mentions using a View and briefly describes what a View can do. However, it should have a detailed section which describes what things can go inside a view element definition and the order in which they apply.

With the main steps being:

  • preAggregationFilterFunctions
  • groupBy
  • aggregator
  • postAggregationFilterFunctions
  • transformFunctions
  • postTransformFilterFunctions

Specifically, it would be good to provide examples to show how order is important and can change the results depending on groupBy and whether filtering is pre or post aggregation.

@t92549 t92549 added the enhancement Improvement to an existing part of the documentation label Dec 18, 2023
@t92549 t92549 added this to the v2.1.0 milestone Dec 18, 2023
@GCHQDeveloper314 GCHQDeveloper314 modified the milestones: v2.1.0, Backlog Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to an existing part of the documentation
Projects
None yet
Development

No branches or pull requests

2 participants