Skip to content

docs: create Common Pitfalls Guide#58

Open
enoshdev wants to merge 1 commit into
AllDotPy:masterfrom
enoshdev:docs-common-pitfalls
Open

docs: create Common Pitfalls Guide#58
enoshdev wants to merge 1 commit into
AllDotPy:masterfrom
enoshdev:docs-common-pitfalls

Conversation

@enoshdev
Copy link
Copy Markdown

Fixes #49

Created a new Common Pitfalls guide page at docs/doc/common-pitfalls.mdx
covering three common mistakes new Ryx users make:

  • select_related vs prefetch_related
  • async context managers
  • awaiting async queries

Each mistake includes a clear problem description and correct solution with code examples.


```python
# Wrong
db = Database()
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ryx doesn't have Database class...
At least make sure you read the docs or your AI has the right context before generating contents for contributions to avoid hallucination ...


# Correct
async with Database() as db:
await db.query(...)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please read the docs...

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.

docs: create 'Common Pitfalls' guide

2 participants