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

Documentation error

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

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
55/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
停滞
技术栈
python
领域
documentation

调研方向

打开链接的 Ping1D API 文档,检查 set 命令的 returns 部分。修正第二个条件,使其指向 verify 为 True,然后确认渲染后的文本区分了 verify=True 和 verify=False 两种情况。

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

描述

On https://docs.bluerobotics.com/ping-python/classbrping_1_1ping1d_1_1Ping1D.html

For the returns section in set commands
If verify is False, True on successful communication with the device. If verify is False, True if the new device parameters are verified to have been written correctly. False otherwise (failure to read values back or on verification failure)

Shouldn't the second one be If verify is True.

主要语言
Python
星标
60
派生
39
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

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

bluerobotics/ping-python 的其他 Issue

查看 bluerobotics/ping-python 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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