Skip to content

Updating the Docs with a diff view #798

Closed
@athul

Description

@athul

Hey,
It would be super cool if you could add a diff view in the docs for the https://docs.graphene-python.org/projects/django/en/latest/tutorial-plain/#getting-single-objects code block.
Plus you could also add the filename to be changed since there are two schema.py files both in cookbook and ingredients.

You could update the sphinx configs to higlight diffs to display like this(example)

  import graphene

  from graphene_django.types import DjangoObjectType

  from cookbook.ingredients.models import Category, Ingredient


  class CategoryType(DjangoObjectType):
      class Meta:
          model = Category


  class IngredientType(DjangoObjectType):
      class Meta:
          model = Ingredient


  class Query(object):
+      category = graphene.Field(CategoryType,
+                                id=graphene.Int(),
+                                name=graphene.String())
      all_categories = graphene.List(CategoryType)


+      ingredient = graphene.Field(IngredientType,
+                                  id=graphene.Int(),
+                                  name=graphene.String())
      all_ingredients = graphene.List(IngredientType)

      def resolve_all_categories(self, info, **kwargs):
+          return Category.objects.all()
+
+      def resolve_all_ingredients(self, info, **kwargs):
+          return Ingredient.objects.all()
+
+      def resolve_category(self, info, **kwargs):
+          id = kwargs.get('id')
+          name = kwargs.get('name')
+
+          if id is not None:
+              return Category.objects.get(pk=id)
+
+          if name is not None:
+              return Category.objects.get(name=name)
+
+          return None
+
+      def resolve_ingredient(self, info, **kwargs):
+          id = kwargs.get('id')
+          name = kwargs.get('name')
+
+          if id is not None:
+              return Ingredient.objects.get(pk=id)
+
+          if name is not None:
+              return Ingredient.objects.get(name=name)
+
+          return None

This way, people new to graphene could understand how the file should be changed.
Thanks and I totally love this project ❤️

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions