Skip to content

[scr_ecto-103] Improve options/configuration described in README #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[scr_ecto-103] Improve options/configuration described in README #104

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b99cc00
scr_ecto-103 | Improve options/configuration described in README.
theirishpenguin Jun 27, 2023
89105cb
reinitialise checks
theirishpenguin Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,35 @@ page =
|> MyApp.Repo.paginate(page: 2, page_size: 5)
```

## Supported Options

There are several options that can be supplied in a dedicated `options` keyword list arg. Here is an example of using `options`...

```elixir
defmodule MyApp.Repo do
use Ecto.Repo, otp_app: :my_app, adapter: Ecto.Adapters.Postgres
use Scrivener, options: [allow_overflow_page_number: true]
end
```

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## Other Configuration
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 behaviour of Ecto Scrivener can also be optionally configured by passing things directly to the `use Scrivener` statement rather than via the `options` keyword list arg. For example...

```elixir
defmodule MyApp.Module do
use Scrivener, page_size: 5, max_page_size: 100
end
```

Here is an explanation of the directly configurable keys...

* `:max_page_size` - This (silently) enforces a hard ceiling for the page size, even if you allow users of your application to specify page_size via query parameters. If not provided, there will be no limit to page size.

## Installation

Add `scrivener_ecto` to your `mix.exs` `deps`.
Expand Down