Skip to content

Documentation Mismatch for Testing API Calls with Django #1515

Open
@hamza-m-farooqi

Description

@hamza-m-farooqi

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions