Missing LOC in django model form documentation (fixes #602)#605

Merged

mvanlonden merged 1 commit intographql-python:masterfrom

GitRon:bugfix/missing-type-declaration-in-docs

Apr 27, 2019

Contributor

GitRon commented Mar 27, 2019

If you don't put this in your code you'll end up with an import error deep in the source code. Took me about 6h work to figure this out 🙈


          Missing LOC in django model form documentation (fixes graphql-python#602

547a4cb

Collaborator

zbyte64 commented Mar 27, 2019

I think PetMutation is suppose to have field name and not pet. What is not shown in the documentation is how to include the PetMutation in the root Mutation class, the LOC here is probably also valid but I don't think it is idiomatic.

zbyte64 added the 📖 documentation label

coveralls commented Mar 27, 2019

Coverage remained the same at 94.356% when pulling 547a4cb on GitRon:bugfix/missing-type-declaration-in-docs into ea2cd98 on graphql-python:master.

4 similar comments

coveralls commented Mar 27, 2019

Coverage remained the same at 94.356% when pulling 547a4cb on GitRon:bugfix/missing-type-declaration-in-docs into ea2cd98 on graphql-python:master.

coveralls commented Mar 27, 2019

Coverage remained the same at 94.356% when pulling 547a4cb on GitRon:bugfix/missing-type-declaration-in-docs into ea2cd98 on graphql-python:master.

coveralls commented Mar 27, 2019

Coverage remained the same at 94.356% when pulling 547a4cb on GitRon:bugfix/missing-type-declaration-in-docs into ea2cd98 on graphql-python:master.

coveralls commented Mar 27, 2019

Coverage remained the same at 94.356% when pulling 547a4cb on GitRon:bugfix/missing-type-declaration-in-docs into ea2cd98 on graphql-python:master.

Contributor Author

GitRon commented Mar 28, 2019

As I said if you don't put this line you get a vague import error. I really think that this needs to be documented!

Contributor Author

GitRon commented Apr 15, 2019

After giving it a second thought I really would be happy if we did not need this line at all. So maybe there is another bug in the background? I did not manage to find out where the problem comes from...

phalt approved these changes

View reviewed changes

mvanlonden approved these changes

View reviewed changes

Member

mvanlonden left a comment

This part of the docs is labeled as experimental so even if this isn't the most idiomatic approach it will save others some headache. Can revisit at a later time with a more idiomatic approach or make this field definition obsolete.

mvanlonden merged commit 2016011 into graphql-python:master

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

Labels

📖 documentation