graphql-python / graphene-django

Build powerful, efficient, and flexible GraphQL APIs with seamless Django integration.
http://docs.graphene-python.org/projects/django/en/latest/
MIT License
4.31k stars 769 forks source link

Documentation Mismatch for Testing API Calls with Django #1515

Open hamza-m-farooqi opened 7 months ago

hamza-m-farooqi commented 7 months ago

What is the current behavior? The documentation for testing API calls with Django on the official website of Graphene-Django shows incorrect usage of a parameter named op_name in the code examples for unit tests and pytest integration. However, upon inspecting the corresponding documentation in the GitHub repository, the correct parameter operation_name is used.

Steps to Reproduce

Visit the Graphene-Django documentation website's section on testing API calls with Django. Observe the use of op_name in the example code blocks. Compare with the content in the testing.rst file in the docs folder of the Graphene-Django GitHub repository, where operation_name is correctly used. Expected Behavior The online documentation should reflect the same parameter name, operation_name, as found in the GitHub repository documentation, ensuring consistency and correctness for developers relying on these docs for implementing tests.

Motivation / Use Case for Changing the Behavior Ensuring the documentation is accurate and consistent across all platforms is crucial for developer experience and adoption. Incorrect documentation can lead to confusion and errors in implementation, especially for new users of Graphene-Django.

vaishnavi-2901 commented 4 months ago

Hey, Would want to work on this issue, please asssign it to me.