Skip to content

Fix some mistakes in documentation #71

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

Merged
merged 2 commits into from
Dec 6, 2016

Conversation

tguillemot
Copy link
Contributor

This PR solves two mistakes in the doc :

  • The PostNode class uses as model Post which does not have any field title
  • The ingredients and recipes directories from examples/cookbook are included in cookbook/cookbook.
    By following the tutorial ingredients and recipes are in cookbook/.

For the second problem there is two possibilities :

  1. There is a mistake in the doc and I can correct it by adding a cd cookbook (as done by the PR)
  2. Correct the examples/cookbook.

Solution 1 is easier but I prefer the solution 2 because it is closer of what is done in the django tutorial. This PR implements the solution 1 but I can change if necessary.

`ingredients` and `recipes` from [examples/cookbook](https://github.com/graphql-python/graphene-django/tree/master/examples/cookbook) are included in cookbook/cookbook. 
By following the tutorial `ingredients` and `recipes` are in `cookbook/`.

Two possibilities : 
1) There is a mistake in the doc and I can correct it by adding a `cd cookbook` (as done by the PR)
2) Correct the [examples/cookbook](https://github.com/graphql-python/graphene-django/tree/master/examples/cookbook).

Solution 1 is easier but  I prefer the solution 2 because it is closer of what is done in the [django tutorial](https://docs.djangoproject.com/en/1.10/intro/tutorial01/).
The `PostNode` class uses as model Post which does not have any field `title`
@coveralls
Copy link

coveralls commented Dec 5, 2016

Coverage Status

Coverage remained the same at 92.441% when pulling 3f139da on tguillemot:master into 22b3321 on graphql-python:master.

@syrusakbary syrusakbary merged commit 0c26e8f into graphql-python:master Dec 6, 2016
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

Successfully merging this pull request may close these issues.

3 participants