Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

why use different behavior for the description of query and mutation

未关闭
#1,325 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
graphql, python
领域
api, backend-api-design

调研方向

首先将 query 字段的描述处理方式与 graphene.mutation 的类方法 Field 进行比较；该方法使用 description 或 cls._meta.description 返回一个 graphene.Field。追踪 doc 以及类型或 mutation 描述如何进入生成的文档。完成的标准是 query 和 mutation 字段遵循相同的文档化优先级，并且测试确认最终生成的描述。

由索引模型根据 Issue 内容生成。

描述

🐛 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.

主要语言
Python
星标
8.2k
派生
818
30 天内没有已合并 PR

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

graphql-python/graphene 的其他 Issue

查看 graphql-python/graphene 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。