strawberry-graphql / strawberry-django

Strawberry GraphQL Django extension
MIT License
391 stars 115 forks source link

Improvement in Documentation #434

Closed ArcD7 closed 6 months ago

ArcD7 commented 7 months ago

Hey, first of all thanks for building this library. We are creating projects on strawberry django since day1.

Just pointing this out, in the documentation strawberry.django and strawberry_django are being used as interchangeable terms. Eg in Mutations.

I'm not sure, what the difference is between those two, it would be good if we can use either one of them or if they work differently then we can have a section which mentions the difference between them.

Upvote & Fund

Fund with Polar

bellini666 commented 7 months ago

Hey @ArcD7 ,

TBH strawberry.django and strawberry_django should be interchangeable (because of this https://github.com/strawberry-graphql/strawberry/blob/main/strawberry/django/__init__.py), but I usually prefer the later as it behaves better with LSPs and is more straight forward.

This is something that for sure would be nice to improve in the docs!

ArcD7 commented 7 months ago

Hey @bellini666 , is it okay, if I take this issue?

I guess, it would be a good way to start contributing.

bellini666 commented 7 months ago

@ArcD7 yeah, go ahead! Contributions are always very welcomed :)

Let me know if you need help with anything. You can either ping me here or on discord

ArcD7 commented 6 months ago

Hey @bellini666 ,

Should the changes be in one PR, multiple commits per page or multiple PR's ie. 1 PR for each page?

bellini666 commented 6 months ago

@ArcD7 whatever you prefer and is better for you :)