sqlmodel icon indicating copy to clipboard operation
sqlmodel copied to clipboard

📝 Update define relationships attributes docs: `Optional[Team]` -> `Team | None`

Open scku208 opened this issue 1 year ago • 3 comments

For users new to SQLModel, the documentation might be confusing. It is recommended to focus on explanations for Python 3.10+ or to include additional parenthetical notes explaining differences from earlier versions.

scku208 avatar Aug 13 '24 15:08 scku208

📝 Docs preview for commit e4eebb0cc62ef8167f9c5e47d4f57ac734c39962 at: https://e9394122.sqlmodel.pages.dev

Modified Pages

  • https://e9394122.sqlmodel.pages.dev/tutorial/relationship-attributes/define-relationships-attributes/

github-actions[bot] avatar Aug 13 '24 15:08 github-actions[bot]

I apologize, but the final reference to Optional[Team] in that particular paragraph should also be updated to Team | None. (also, Optional[int] should be updated to int | None)

scku208 avatar Aug 13 '24 15:08 scku208

📝 Docs preview for commit a12d320091a8a218804ce5c42af7601e13a91e98 at: https://e04f716f.sqlmodel.pages.dev

Modified Pages

  • https://e04f716f.sqlmodel.pages.dev/tutorial/relationship-attributes/define-relationships-attributes/

github-actions[bot] avatar Sep 03 '24 14:09 github-actions[bot]

I apologize, but the final reference to Optional[Team] in that particular paragraph should also be updated to Team | None. (also, Optional[int] should be updated to int | None)

@scku208 could you update the PR with this change so we can get this ready to be merged?

iloveitaly avatar Mar 27 '25 13:03 iloveitaly

Thanks! This was covered in https://github.com/fastapi/sqlmodel/pull/1351, so I'll close this one now. :nerd_face: :coffee:

tiangolo avatar Apr 27 '25 18:04 tiangolo