Skip to content

Conversation

@berkaykrc
Copy link

Description

I noticed a sentence in the Models with Relationships section that was slightly ambiguous and caused confusion about which model was being described.

In the paragraph discussing recursion, the text says:

"Also, notice that the field team is not declared with this new TeamPublicWithHeroes..."

Because the sentence omits the subject (the HeroPublicWithTeam class), it reads as if the text is describing a field inside TeamPublicWithHeroes, rather than explaining how the team field is typed inside the Hero model.

Changes

I have updated the text to explicitly state that we are looking at the HeroPublicWithTeam model.

Example of clarification:

Before: "Also, notice that the field team is not declared with this new TeamPublicWithHeroes..."

After: "Also, notice that in the HeroPublicWithTeam model, the field team is not declared with this new TeamPublicWithHeroes class..."

This small change reduces cognitive load and prevents readers from looking for a logic error in TeamPublicWithHeroes.

@github-actions github-actions bot added the docs Improvements or additions to documentation label Dec 15, 2025
@github-actions
Copy link
Contributor

@YuriiMotov YuriiMotov changed the title docs: Fix ambiguous phrasing regarding HeroPublicWithTeam model 📝 Fix ambiguous phrasing regarding HeroPublicWithTeam model Dec 24, 2025
Copy link
Member

@YuriiMotov YuriiMotov left a comment

Choose a reason for hiding this comment

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

@berkaykrc, thanks!

I agree this way it reads a bit easier.

We can also update the paragraph above:

- Now, notice that these new fields `team` and `heroes` are not declared with `Relationship()`, because these are not **table models**, they cannot have **relationship attributes** with the magic access to get that data from the database.
+ Now, notice that these new fields `team` and `heroes` are not declared with `Relationship()`, because `HeroPublicWithTeam` and `TeamPublicWithHeroes` are not **table models**, they cannot have **relationship attributes** with the magic access to get that data from the database.

("these" replaced with explicit "HeroPublicWithTeam and TeamPublicWithHeroes")

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

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants