raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-02-22 00:57:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add reports readme [doc]

Browse Source 
It doesn't say much yet, but could be a helpful starting point. Hopefully we will add to it next time we're working on it.

[skip ci]
This commit is contained in:
David Cook
2023-12-29 13:58:48 +11:00
parent 263f68f927
commit e62cd0eb89
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/reporting/readme.md Normal file
View File

@@ -0,0 +1,9 @@
# Reports framework
A framework that handles querying and rendering tabular data.
TODO: add more details on how each part works.
## Rules
Rules are used for grouping, ordering, and summary rows. Options are documented at [`Reporting::ReportTemplate#rules`](
https://github.com/openfoodfoundation/openfoodnetwork/blob/master/lib/reporting/report_template.rb#L68-L95).