DEFAULT_ORPHANS inconsistent with documentation

[kernc]

The documentation for DEFAULT_ORPHANS setting says:

The minimum number of articles allowed on the last page. Use this when you don’t want the last page to only contain a handful of articles.

However, with

DEFAULT_PAGINATION = 1
DEFAULT_ORPHANS = 1

and with three articles paginated, one appears on the first page and two on the second. The same setup with DEFAULT_PAGINATION = 2 produces a single, unpaginated page.

So it seems that (DEFAULT_ORPHANS + 1) is the minimum number of articles allowed on the last page.

[leotrs]

@kernc can you still replicate this?

[kernc]

Seems so. With pelican git, given three articles in a paginated category,

DEFAULT_PAGINATION = 1
DEFAULT_ORPHANS = 1

results in two pages (1+2). Expected are three pages (1+1+1).

Likewise,

DEFAULT_PAGINATION = 2
DEFAULT_ORPHANS = 1

results in a single, unpaginated page. Expected are two pages (2+1).

Both of these behaviors are inconsistent with docs for DEFAULT_ORPHANS.

Setting in both above cases DEFAULT_ORPHANS = 0 results in expected behavior (as noted above). This seems to indicate DEFAULT_ORPHANS is really interpreted as DEFAULT_ORPHANS + 1.

[leotrs]

Sounds like a change in documentation could solve this issue. PRs are welcome.

[kernc]

That would be the easy and probably invalid fix. Got something better in #1992, I hope. 😃

[kernc]

Resolution: invalid #1992 (comment).
Thanks.