Skip to content

Fix inaccurate documentation, unresolvable references and typos #228

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

Merged
hlindset merged 6 commits into from
Aug 5, 2026
Merged

Fix inaccurate documentation, unresolvable references and typos #228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
41fbaa4
Correct documented option names and defaults to match the validators
hlindset Aug 5, 2026
ed00cc2
Fix typos in documentation, comments and type definitions
hlindset Aug 5, 2026
c71910c
Correct the @doc since versions in Image.Shape
hlindset Aug 5, 2026
c69dd9d
Use full module names in doc type references so they resolve in hexdocs
hlindset Aug 5, 2026
f975ab5
Fix documentation references that do not resolve
hlindset Aug 5, 2026
c234416
Reserve backticks for code in three prose references
hlindset Aug 5, 2026
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ Documentation can be found at <https://hexdocs.pm/image>.

* **ICC colour profiles** — `Image.ICCProfile` for libvips' built-in profiles (`:srgb`, `:cmyk`, `:p3`) and arbitrary `.icc` files.

* **Image streaming** — open and write directly from `File.Stream`s, Plug `Conn`s, in-memory binaries, and S3 sources.
* **Image streaming** — open and write directly from `File.Stream`s, `Plug.Conn`s, in-memory binaries, and S3 sources.

* **Optional integrations** — each is compiled only when its optional dependency is present:

* `Image.Video` (frame extraction, seek, webcam) via [Xav](https://hex.pm/packages/xav), an Elixir wrapper around FFmpeg. Requires FFmpeg 6.x or 7.x on the system.

* QR code encoding and decoding via the sibling [`image_qrcode`](https://hex.pm/packages/image_qrcode) package (Nayuki QR-Code-generator + quirc; no `:evision` dependency).

* `Image.k_means` via [Scholar](https://hex.pm/packages/scholar).
* `Image.k_means/2` via [Scholar](https://hex.pm/packages/scholar).

* `Image.to_nx/2` / `Image.from_nx/1` via [Nx](https://hex.pm/packages/nx).

Expand Down
Loading
Loading