Pygithub: 文档字符串问题

创建于 2016-07-22 · 24评论 · 资料来源: PyGithub/PyGithub

我在我的开发环境中使用 PyCharm。我注意到您的代码使用文档字符串进行了详细记录。例如：

    def get_user(self, login=github.GithubObject.NotSet):
        """
        :calls: `GET /users/:user <http://developer.github.com/v3/users>`_ or `GET /user <http://developer.github.com/v3/users>`_
        :param login: string
        :rtype: :class:`github.NamedUser.NamedUser`
        """

但是，这似乎不是合适的语法，因为我的 IDE 仍然认为结果可能是 Any。但是，如果我删除:class: ，它可以正常工作。你能给我发送任何指向:class:标准的链接吗？我要脱此。

资料来源

RSully

👍2

最有用的评论

你好！这是我对每个仍然相关且即将被陈旧机器人关闭的问题的通用答复。

Croydon 于 2020-10-04

😄1 👍1

所有24条评论

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2018-07-05

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2018-09-10

没有任何变化或答案。不要自动关闭。

RSully 于 2018-09-11

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2018-11-10

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2019-01-09

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2019-03-11

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2019-05-10

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2019-07-12

它暗示了我们的文档构建——见https://pygithub.readthedocs.io/en/latest/github_objects/Branch.html#github.Branch.Branch.get_required_status_checks ，没有 :class: 它不链接返回类型到班级。

s-t-e-v-e-n-k 于 2019-07-15

自提交此问题以来的 3 年中，语法是否有可能发生了变化？更重要的是，我更感兴趣的是找到一个指向文档的链接，该链接表明它是必要的（而不是指向您的文档在我们中展示它的位置的链接），因为 - 至少 3 年前（直到今天，不少于！） - 此语法破坏了 PyCharm。我想它现在必须标准化。

PS：我必须说我很惊讶看到任何关于此的活动，在此期间我和过时的机器人已经成为很好的朋友😊

RSully 于 2019-07-23

语法可能已更改，但我找不到有关 Sphinx 的任何文档，并且它有效，所以我不愿意更改它。此外，它早于我参与该项目的日期，因此加倍。

s-t-e-v-e-n-k 于 2019-07-23

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2019-09-21

随心所欲，但我鼓励您使用 IDE 使用的语法，以使贡献者的工作更轻松。我不确定 PyCharm 现在是否支持这种语法，但当时肯定不支持。

RSully 于 2019-09-21

👍1

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2019-11-20

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2020-01-20

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2020-03-22

为什么其他问题没有被标记为过时？我们可以将其取消标记为问题吗？

RSully 于 2020-03-26

啊哈，我找到了文档。 https://www.sphinx-doc.org/en/1.5/domains.html#python -roles

您是否考虑过为此针对 PyCharm 提交错误？

s-t-e-v-e-n-k 于 2020-03-26

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2020-05-25

👎1

据我所知， :class:语法是在 Sphinx 文档中创建一个类的链接，而不是在:rtype:实际指定返回类型。

例如，我希望这是它的使用方式（未测试）：

:rtype: github.NamedUser.NamedUser The rest of this text is describing the return type and may contain links to other classes like :class:`github.CommitStatus.CommitStatus` which would show up in the Sphinx documentation.

RSully 于 2020-05-25

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2020-07-25

👎1

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2020-10-04

👎1

你好！这是我对每个仍然相关且即将被陈旧机器人关闭的问题的通用答复。

Croydon 于 2020-10-04

😄1 👍1

此问题已自动标记为过时，因为它最近没有活动。如果没有进一步的活动发生，它将被关闭。感谢你的贡献。

stale[bot] 于 2020-12-19

此页面是否有帮助？

0 / 5 - 0 等级

Pygithub: 文档字符串问题

最有用的评论

所有24条评论

相关问题