Skip to content

Remove docs link to Ecto.Repo.update_all#227

Merged
ruslandoga merged 2 commits intoplausible:masterfrom
greg-freewave:unlink_ecto_repo_update_all
Mar 20, 2025
Merged

Remove docs link to Ecto.Repo.update_all#227
ruslandoga merged 2 commits intoplausible:masterfrom
greg-freewave:unlink_ecto_repo_update_all

Conversation

@greg-freewave
Copy link
Contributor

@greg-freewave greg-freewave commented Mar 20, 2025

Simply removes the code link to Ecto.Repo.update_all because that is not a function that actually exists and it causes a warning when generating docs.

As part of my company's project we generate docs for our app and all deps to host for devs. This is part of an effort to remove all warnings from that process.

I.E.

> mix docs
Compiling 2 files (.ex)
Generated ecto_ch app
Generating docs...
    warning: documentation references function "Ecto.Repo.update_all/3" but it is undefined or private
    │
  2 │   use Ecto.Repo,
    │   ~~~~~~~~~~~~~~
    │
    └─ (ecto_ch 0.6.0) dev/repo.ex:2: Dev.Repo.alter_update_all/3

View "html" docs at "doc/index.html"
    warning: documentation references function "Ecto.Repo.update_all/3" but it is undefined or private
    │
  2 │   use Ecto.Repo,
    │   ~~~~~~~~~~~~~~
    │
    └─ (ecto_ch 0.6.0) dev/repo.ex:2: Dev.Repo.alter_update_all/3

View "epub" docs at "doc/Ecto ClickHouse.epub"

After this PR:

> mix docs
Compiling 2 files (.ex)
Generated ecto_ch app
Generating docs...
View "html" docs at "doc/index.html"
View "epub" docs at "doc/Ecto ClickHouse.epub" 

@greg-freewave greg-freewave changed the title Remove docs reference to Ecto.Repo.update_all Remove docs link to Ecto.Repo.update_all Mar 20, 2025
@ruslandoga
Copy link
Collaborator

👋 @greg-freewave

Thank you for catching this!

link to callback

Co-authored-by: felipe stival <14948182+v0idpwn@users.noreply.github.com>
@ruslandoga ruslandoga merged commit 5e7ecc8 into plausible:master Mar 20, 2025
@ruslandoga
Copy link
Collaborator

Published as https://hex.pm/packages/ecto_ch/0.6.1

Thank you again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants