[scr_ecto-103] Improve options/configuration described in README #104
Conversation
|
One check fails above with the following error...
Is there something I should do to correct this? (As this is just a documentation change, I'm conscious it's probably best if I don't go messing with the actual codebase as part of this PR 😄 ) |
|
A fellow Elixir-er kindly helped me out with the build issue at https://github.com/theirishpenguin/scrivener_ecto/pull/1/files Looking at that PR, it seems like there is an issue building scrivener_ecto with |
|
@theirishpenguin We have updated the master branch of Scrivener_Ecto to support OTP 26. If you want to rebase your PR work here off the current master, we can look at getting these documentation changes in. |
theirishpenguin
force-pushed
the
scr_ecto-103--improve-docs
branch
from
4947391 to
2bde3cf
Compare
theirishpenguin
force-pushed
the
scr_ecto-103--improve-docs
branch
from
2bde3cf to
b99cc00
Compare
|
@cpjolicoeur Thanks 🙌 I've just rebased this PR now off the current master. |
theirishpenguin
force-pushed
the
scr_ecto-103--improve-docs
branch
3 times, most recently
from
abdc4ae to
b99cc00
Compare
|
I have tried to kick off the build again with a "reinitialise checks" commit, but it seems like that needs approval from a maintainer. (I did have a few problems with that commit - all fixed now - so maybe that is why it requires manual approval). Is it possible for someone to kick off a build on this PR? |
|
Seems like all checks have been passed 🥳
Can this now be merged? |
|
|
||
| Here is an explanation of the supported options... | ||
|
|
||
| * `:allow_overflow_page_number` - If set to true then when you supply a page greater than the total pages, it will return an empty list for entries. If set to false then it will (silently) treat any supplied `page` arg as if it was equal to the total pages. Default is false. |
There was a problem hiding this comment.
On line 71 you mention "there are several supported options", but then we proceed to only document a single option. We should either a) document the options available that scrivener_ecto uses, or b) point people (via link) to the documented options directly in the Scrivener docs.
|
|
||
| * `:allow_overflow_page_number` - If set to true then when you supply a page greater than the total pages, it will return an empty list for entries. If set to false then it will (silently) treat any supplied `page` arg as if it was equal to the total pages. Default is false. | ||
|
|
||
| ## Other Configuration |
There was a problem hiding this comment.
These two sections (Supported Options and Other Configuration) can just be a single "Scrivener configuration" section as they both directly related to configuring Scrivener directly. There is no need to separate them out into different sections.
The Problem
The README does not mention options such as :allow_overflow_page_number and direct configuration such as :max_page_size. This is noted in issue #103
This PR is to (make a start at least) on correcting that.