metabase / metabase/toucan

Fix docs to clarify that `update-where!` doesn't call pre-update (or post-update)

Open
#76 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Clojure
Stars
576
Forks
48
PR merge metrics
No merged PRs in 30d

Description

https://github.com/metabase/toucan/blob/master/docs/db-functions.md#update-where says `update-where` does not call `pre-update` while https://github.com/metabase/toucan/blob/master/docs/defining-models.md#pre-update says `pre-update` gets called, while `post-update` does not.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the `update-where` section in `docs/db-functions.md` and the `pre-update` section in `docs/defining-models.md`. Reconcile the wording so both sections clearly state that `update-where!` calls neither `pre-update` nor `post-update`, then verify the linked documentation is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.