Document and clean up VehicleSpecification
维护者通常 9 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 82/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- python
调研方向
从 src/components/vehicle/vehicle_specification.py 开始,检查 VehicleSpecification 的参数和派生的尺寸计算。为每个参数注明单位,说明未解释的常量或将其参数化,对可变限制使用 None 作为默认值,并重命名 area_size 以包含单位。当文档中的单位和默认值与实现一致,且不同实例不共享可变限制对象时,工作即告完成。
由索引模型根据 Issue 内容生成。
描述
Problem
In src/components/vehicle/vehicle_specification.py:
- Derived sizes use unexplained constants:
f_edge_m = f_len_m + 0.5,tread_m = 0.25 * (1.0 + f_len_m + r_len_m),width_m = 1.0 * tread_m x_lim=MinMax(-30, 30)andy_lim=MinMax(-30, 30)are default arguments evaluated once, so all instances share the same objectsarea_sizehas no unit in its name, andaxle_half_mis not documented
Expected fix
Name and explain the constants (or make them parameters with documented defaults), use None defaults for mutable arguments, rename area_size with a unit suffix, and document every argument with its unit.
- 主要语言
- Python
- 星标
- 1.9k
- 派生
- 313
- 平均合并
- 9 天 10 小时
- 30 天内合并 PR
- 7
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
ShisatoYano/AutonomousVehicleControlBeginnersGuide 的其他 Issue
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 78/100
ShisatoYano/AutonomousVehicleControlBeginnersGuide#99 ·
维护者通常 9 天内回复
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 82/100
ShisatoYano/AutonomousVehicleControlBeginnersGuide#98 ·
维护者通常 9 天内回复
-
documentation enhancement
难度 2/5 1-3 小时 新手友好度 76/100
ShisatoYano/AutonomousVehicleControlBeginnersGuide#88 ·
维护者通常 9 天内回复
-
long term
难度 5/5 一周以上 新手友好度 25/100
ShisatoYano/AutonomousVehicleControlBeginnersGuide#131 ·
维护者通常 9 天内回复
-
Clean up State and keep trajectory drawing fast可能已有人在做 @Cid-oe 于 27 天前认领。 未关闭good first issue refactoring
难度 3/5 1-2 天 新手友好度 76/100
ShisatoYano/AutonomousVehicleControlBeginnersGuide#130 ·
维护者通常 9 天内回复
查看 ShisatoYano/AutonomousVehicleControlBeginnersGuide 的全部 Issue
相似的 Issue
-
_chunk_scan_fwd launches its Triton kernel without a device guard: NaN when a model is split across GPUs可能已有人在做 @toddwbucy 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 85/100
state-spaces/mamba#1072 ·
-
难度 1/5 1 小时以内 新手友好度 85/100
loopj/aiovantage#414 ·
维护者通常 1 天内回复
-
power_mismatch_deline docstring: the rear-to-total RMAD conversion has an extra bifaciality factor未关闭
难度 1/5 1 小时以内 新手友好度 85/100
pvlib/pvlib-python#2929 ·
维护者通常 1 天内回复
-
data good first issue launch-day unverified
难度 2/5 1-3 小时 新手友好度 78/100
BradGroux/wow-forever-mission-control#8 ·
维护者通常 1 天内回复
-
check bilibili falsely reports read/subtitle as broken: live_test fixture BV1GJ411x7h7 is gone (404)未关闭
难度 2/5 1-3 小时 新手友好度 78/100
Panniantong/Agent-Reach#889 ·
维护者通常 2 天内回复