Conversation
2 similar comments
|
This is a huge leap forward @phalt, thank you. Most of my feedback above is stylistic and grammatical in nature. The broad strokes of your work are spot on. My only high level concerns:
|
|
Thanks for the feedback @dopeboy and @subwindow Yes, my grammar isn't great so that feedback is useful for me! Regarding your points:
I've not yet updated the basic tutorial guide but I want to reduce some of the duplication. I'm also aware the current docs are hard to read because it's all spread out. Does it make sense to duplicate a few things just to make it easier to read through a page in one go? Suggestions welcome.
Yeah I wanted to make this clearer and I think it'll be better as I finish up. I based the docs around how I see the project from the point of view of a user - what does a user want to do versus what does this project provide. For example - currently Django users come to these docs, see a bare minimum of content, and don't know they have to visit the core graphene docs to find what they need.
Again, I don't really see Relay as a separate topic but rather an extension on top of Queries / Mutations. This is my opinion, and I'm happy to change it if the consensus is that it should be separate. But I feel like it flows better to talk about Relay for Queries when talking about Queries, etc. |
| id = graphene.ID() | ||
|
|
||
| # The class attributes define the response of the mutation | ||
| question = graphene.Field(QuestionType) |
There was a problem hiding this comment.
Can also do Output = QuestionType and then just return the question instance in the mutate method
There was a problem hiding this comment.
Well today I learned! See, this is why we need the better docs 😆 I'll add this
|
This is a vast improvement on what we currently have. Thank you 🙏 |
zbyte64
left a comment
There was a problem hiding this comment.
Thank you for improving the documentation
|
Just wanted to pop in and say thanks for updating the docs 🎉 |
|
@clarkmoody no problems, wait until you see what I do next! |
|
@phalt great job! So much better! |
|
@jkimbo thanks! |
Rewrite of the documentation, splitting up the docs into the following structure:
Django REST Framework and Django forms will move under "mutations".
Relay will move under queries and mutations (where it makes sense).
I am NOT rewriting the tutorials yet as they're huge!
TODO: