Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

why use different behavior for the description of query and mutation

Đang mở
  • Có gì không ổn?
#1,325 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
graphql, python
Lĩnh vực
api, backend-api-design

Hướng nghiên cứu

Bắt đầu bằng cách so sánh việc xử lý mô tả của trường query với classmethod Field của graphene.mutation, phương thức này trả về một graphene.Field bằng cách sử dụng description hoặc cls._meta.description. Theo dõi cách doc và các mô tả kiểu hoặc mutation đi tới tài liệu được tạo. Công việc được coi là hoàn thành khi các trường query và mutation tuân theo cùng một thứ tự ưu tiên được ghi trong tài liệu và các bài kiểm thử xác nhận các mô tả thu được.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

🐛 bug

  • What is the current behavior?
    Now, the query description only use the description=... args for docs, the description or the doc in Typeclass only use for Type docs.
    but the mutation use the description args or the description of mutation class or the doc of mutation class for both mutation docs and mutation class docs.

  • What is the expected behavior?
    Both query and mutation should share the same logic for docs, first use the description arg of the field, then the description of meta class of class, the last is using doc of (the type or mutation) class.

  • Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow)
    dig into code, I find the graphene.mutation has a classmethod func named Field which return graphene.Field with description=description or cls._meta.description.

Ngôn ngữ chính
Python
Star
8.2k
Fork
822
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của graphql-python/graphene

Tất cả issue của graphql-python/graphene

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.