SeaQL / SeaQL/seaql.github.io

Add `on_delete = "Cascade"` to an example in the docs

Open Beginner friendly
#172 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
HTML
Stars
24
Forks
68
PR merge metrics
No merged PRs in 30d

Description

Motivation

I was confused on how to add an ON DELETE CASCADE constraint via macros. The docs mention it once, a generic example randomly includes it, but the deletion page never talks about it.

Proposed Solutions

It would be great if the deletion page could include an example of a more complex case with relations. A few words about the difference between adding on_delete = "Cascade" to the relation and calling .cascade_delete(). (I noticed that the later didn't work on its own?)

Additional Information

Contributor guide

Open the contributing guide

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

Start with the documentation's deletion page and find the existing on_delete example and any references to cascade_delete(). Add a relations example showing on_delete = "Cascade" and explain how it differs from calling .cascade_delete(). Done means the deletion page clearly covers both approaches and the example renders correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.