bluerobotics / bluerobotics/ping-python

Documentation error

未关闭
#126 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
60
派生
39
PR 合并指标
30 天内没有已合并 PR

描述

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.

贡献指南

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

调研方向

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

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

评估

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

把新 issue 发到你的邮箱

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