Skip to content

Generate description out of sqlalchemy doc #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 of 3 tasks
comtihon opened this issue Feb 9, 2024 · 1 comment
Closed
1 of 3 tasks

Generate description out of sqlalchemy doc #121

comtihon opened this issue Feb 9, 2024 · 1 comment

Comments

@comtihon
Copy link

comtihon commented Feb 9, 2024

Would be nice if docs from sqlalchemy fields form schema description

class Project(Base):
    __tablename__ = "projects"
    address = Column(String, nullable=False, doc="This is an address")

Feature Request Type

  • Core functionality
  • Alteration (enhancement/optimization) of existing feature(s)
  • New behavior

Description

For some reason chatgpt is sure that it will work, but I tested it with latest version and I can't see comments from doc.
What works for me is only setting it via core stawberry manually:

name: str = strawberry.field(description="The name of the user")

but this kills the whole idea of this library since I have to write boilerplate code for every model.
Would be perfect for autodocumentation support if I can set up docs in my entites and get them converted in the schema description.

@Ckk3
Copy link
Contributor

Ckk3 commented Apr 9, 2025

I will close this issue based on @erikwrede comment in this Pull Request

@Ckk3 Ckk3 closed this as not planned Won't fix, can't repro, duplicate, stale Apr 9, 2025
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

No branches or pull requests

2 participants