cost 17 ms
function 有多个不同返回时的 PEP8 最佳文档字符串实践

我有以下 function: 在 function 定义中如何放置不同的返回元组? 如果我有一个返回类型,我会写: def eg_fun(eg:int) -> Tuple[int, int]: 但在这种情况下,我有两种不同的返回类型,第一个是Tuple[int, int]而第二个是Tuple[ ...

2022-09-26 14:35:21 1 10
如何在 numpy.random 模块中找到文档字符串?

我尝试在 vscode 中找到numpy.random.random() vscode的文档字符串。 为此,我可以继续使用go to definition从菜单或按f12键导航到定义。 ...但我最终导航到这行代码: 我不仅没有找到文档字符串,而且我不明白省略号(三个点... )的作用或这行代码 ...

2022-09-25 13:57:59 0 16
Python 注释以“#?”开头 [关闭]

关闭。 这个问题需要细节或清晰。 它目前不接受答案。 想改进这个问题? 通过编辑此帖子添加详细信息并澄清问题。 9 小时前关闭。 这篇文章在9 小时前被编辑并提交审核。 改进这个问题我有旧的和外国的代码。 在那里我发现了这样的评论 有没有人见过这样的东西? 也许这个语法/约定属于我不知道的自 ...

2022-09-22 07:34:34 0 49
使用 sphinx-autoapi 部署期间的持久缓存?

我被一个问题困扰了好几天没有解决方案。 我正在尝试将使用 Sphinx 生成的本地文档部署到 Gitlab 页面。 下面是我在 repos 根目录上的.gitlab-ci.yml ,我使用的是最新的 Ubuntu 图像: 我在 sphinx-build 期间使用了标签-E和-a来强制重建所有 HT ...

2022-09-19 17:29:04 1 18
我怎样才能得到如图所示的结果? [关闭]

关闭。 这个问题需要细节或清晰。 它目前不接受答案。 想改进这个问题? 通过编辑此帖子添加详细信息并澄清问题。 10 小时前关闭。 改进这个问题这是图片: 我应该做什么操作? ...

2022-09-14 02:54:11 0 17
如何解决 flake8 错误“D205:摘要行和描述之间需要 1 个空白行”?

我正在尝试使用 flake8(pydocstyle) 检查我的文档字符串的质量,我收到了这个错误: D205:摘要行和描述之间需要 1 个空白行这是我的代码的样子示例: 很难分开的长消息。 而 max line length = 100 如何正确地将句子转移到另一行? 还是在这种情况下更容易忽略 ...

2022-09-09 10:14:53 1 18
如何记录方法的 *args 参数? [Python]

当它包含 * args参数时,如何使用 NumPy (PEP 257) 约定记录方法 arguments? 比如我的class中有这样一个方法: go 在参数部分应该是什么? 如果我的意图是确保能够提供单个 object(Seis)或三个对象(str、str、Interval),那么记录此内容的 ...

2022-09-01 03:37:50 0 23
PyCharm 无法识别“.. note::”和“.. deprecated::”注释

我将我的 PyCharm 设置为使用 reStructured 文档字符串格式,但是它不识别.. note::或.. deprecated:: 。 我的意思是,当您通过具有此类注释的方法 hover 时,它会将它们显示为纯文本。 然而,在:param和:return:的情况下,将显示具有不同字体的单 ...

2022-08-14 19:18:28 0 14
Ruby 场记录DSL方法定义及其用途>

Ruby 带码 0.9.8。 我在ClassMethods模块中定义自定义属性访问器,该模块将扩展到分类模块和其他模块。 我想要做的是记录 DSL 访问器方法的作用并将其附加到它们的定义中,但是方法的调用继承了关于参数、返回值等的通用文档字符串,用于每次使用。 但是,在访问器方法的定义上使用@! ...

2022-08-04 00:58:59 0 7
如何从夹具中读取测试函数的文档字符串?

我试图从 conftest.py 中定义的夹具中获取所有测试函数的文档字符串,如下面的代码所示,以便对其进行分析。 但是,当 function 只能作为字符串( request.node.name )使用时,如何从这里访问 function 的__doc__属性? 有没有办法通过request或从 ...

2022-07-31 08:55:06 1 24
如何使 pybind11 属性文档字符串显示出来?

我有以下代码: 根据这个答案,这是传递文档字符串的正确方法。 但是当我在 python (3.6) 中检查它时帮助(记录器) 我得到空的数据描述符: 我怎样才能让文档字符串出现在 python 帮助中? ...

2022-07-27 12:53:04 1 25
Sphinx Python - 带有 .. autofunction 的重载函数的文档字符串

在具有多个@overload装饰器的函数上使用 Sphinx 的.. autofunction::指令时遇到问题。 虽然包含了函数的原型,但我想要的文档字符串却没有。 它产生什么: 我想要的是这样的:(注意原型下面的文档字符串): 我的狮身人面像代码: 功能代码片段(缩短): @over ...

2022-07-22 22:02:52 0 16
使用 MkDocs 和 MkDocstrings 自定义目录

我正在使用 MkDoc 和 MkDocstrings 来编写我的 Python 项目的文档。 在参考部分,我使用文档字符串(特别是类文档字符串)来尽可能地自动化编写。 不幸的是,目录不是我想要的。 具体来说,我在mkdocs.yml中写了这个 内部reference/wos.md我有 一切 ...

2022-07-21 09:27:02 0 25
Docstring 中的缩进

我在 Spyder 5.2.1 上使用 Python 3.9.12。 我正在尝试编写如下的文档字符串。 但是,当我将鼠标悬停在函数名称上时,会忽略缩进。 我尝试过使用空格和制表符进行缩进。 都不工作。 有没有办法在文档字符串中缩进? ...

2022-07-18 14:00:55 0 29

 
粤ICP备18138465号  © 2020-2022 STACKOOM.COM