summaryrefslogtreecommitdiff
path: root/devel/p5-Data-Page/DESCR
diff options
context:
space:
mode:
Diffstat (limited to 'devel/p5-Data-Page/DESCR')
-rw-r--r--devel/p5-Data-Page/DESCR9
1 files changed, 9 insertions, 0 deletions
diff --git a/devel/p5-Data-Page/DESCR b/devel/p5-Data-Page/DESCR
new file mode 100644
index 00000000000..4d18ae260e0
--- /dev/null
+++ b/devel/p5-Data-Page/DESCR
@@ -0,0 +1,9 @@
+When searching through large amounts of data, it is often the case that a
+result set is returned that is larger than we want to display on one page. This
+results in wanting to page through various pages of data. The maths behind this
+is unfortunately fiddly, hence this module.
+
+The main concept is that you pass in the number of total entries, the number of
+entries per page, and the current page number. You can then call methods to
+find out how many pages of information there are, and what number the first and
+last entries on the current page really are.