resources/page: Deprecate PageSize in favor of PagerSize

See #12572
This commit is contained in:
Bjørn Erik Pedersen 2024-06-09 11:16:20 +02:00
parent 9f22bc4414
commit 9c3143c45a
2 changed files with 11 additions and 3 deletions

View file

@ -19,6 +19,7 @@ import (
"math"
"reflect"
"github.com/gohugoio/hugo/common/hugo"
"github.com/gohugoio/hugo/config"
"github.com/spf13/cast"
@ -194,7 +195,14 @@ func (p *Paginator) Pagers() pagers {
}
// PageSize returns the size of each paginator page.
// Deprecated: Use PagerSize instead.
func (p *Paginator) PageSize() int {
hugo.Deprecate("PageSize", "Use PagerSize instead.", "v0.128.0")
return p.size
}
// PagerSize returns the size of each paginator page.
func (p *Paginator) PagerSize() int {
return p.size
}

View file

@ -114,7 +114,7 @@ func doTestPages(t *testing.T, paginator *Paginator) {
c.Assert(len(paginatorPages), qt.Equals, 5)
c.Assert(paginator.TotalNumberOfElements(), qt.Equals, 21)
c.Assert(paginator.PageSize(), qt.Equals, 5)
c.Assert(paginator.PagerSize(), qt.Equals, 5)
c.Assert(paginator.TotalPages(), qt.Equals, 5)
first := paginatorPages[0]
@ -172,7 +172,7 @@ func doTestPagerNoPages(t *testing.T, paginator *Paginator) {
c := qt.New(t)
c.Assert(len(paginatorPages), qt.Equals, 1)
c.Assert(paginator.TotalNumberOfElements(), qt.Equals, 0)
c.Assert(paginator.PageSize(), qt.Equals, 5)
c.Assert(paginator.PagerSize(), qt.Equals, 5)
c.Assert(paginator.TotalPages(), qt.Equals, 0)
// pageOne should be nothing but the first
@ -187,7 +187,7 @@ func doTestPagerNoPages(t *testing.T, paginator *Paginator) {
c.Assert(pageOne.TotalNumberOfElements(), qt.Equals, 0)
c.Assert(pageOne.TotalPages(), qt.Equals, 0)
c.Assert(pageOne.PageNumber(), qt.Equals, 1)
c.Assert(pageOne.PageSize(), qt.Equals, 5)
c.Assert(pageOne.PagerSize(), qt.Equals, 5)
}
func TestProbablyEqualPageLists(t *testing.T) {