Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Replace VehicleTrailer/DiffSteerTrailer with an ArticulatedVehicle (or delete them)

Đang mở
  • Có gì không ổn?
#773 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
22/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
robotics

Hướng nghiên cứu

The classes live in src/roboticstoolbox/mobile/Vehicle.py: Trailer, DiffSteerTrailer, VehicleTrailer, and the VehicleBase they should derive from. Start by reading VehicleBase.__init__ next to VehicleTrailer.__init__ and step to see which base attributes are missing, then search the repo for imports of these classes. Done means a recorded decision (ArticulatedVehicle or deletion), with the remaining code covered by tests and docstrings.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

tech-debt

Trailer, DiffSteerTrailer and VehicleTrailer in src/roboticstoolbox/mobile/Vehicle.py were a late addition, are not used in the book, and are in poor shape. They are not exported from roboticstoolbox, have no tests and are not in the docs, so only code that imports them from roboticstoolbox.mobile.Vehicle can be affected.

Found during the type-hinting pass. They were annotated only to the extent needed for mypy to pass; their defects were recorded, not fixed.

Proposal

Investigate replacing VehicleTrailer and DiffSteerTrailer with a single ArticulatedVehicle class that is a proper VehicleBase subclass and composes a Trailer. Drop DiffSteerTrailer. This is a design question, not a patch.

Known defects (headstart)

  • VehicleTrailer does not call super().__init__, so most VehicleBase attributes (_V, _control, ...) do not exist on it; _x0 is not converted to an array; step returns None where the base returns odometry (hence # type: ignore[override]). Needs a decision: composition, or a proper subclass.

  • VehicleTrailer.plot is a copy of DiffSteerTrailer.plot and uses self._L1, self._L2, self._animation_trailer, none of which exist on VehicleTrailer. Dead code.

  • DiffSteerTrailer.deriv has a leftover print(X[2], eta, etad) and a dead if X[2] > 0.01: pass; DiffSteerTrailer.__init__ calls x0.copy(), which only works because the default is a list.

  • Trailer._animation was only set when an animation or polygon was given, but VehicleTrailer.init reads it (initialised to None in the typing PR; it crashed before).

  • DiffSteerTrailer.init called self._animation_trailer.add even when trailer=None (now guarded).

  • Trailer.__init__ has placeholder docstring text (_summary_, _description_).

  • The runblock example in the VehicleTrailer.step docstring uses VehicleTrailer and Trailer without importing them (a NameError when the docs are built)

Acceptance

  • Decide: ArticulatedVehicle or delete.
  • Whatever remains has tests, docs and a docstring, and VehicleBase attributes are all initialised.
Ngôn ngữ chính
C++
Star
3.5k
Fork
639
Merge trung bình
1 ngày 16 giờ
Pull request đã merge (30 ngày)
88

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của petercorke/robotics-toolbox-python

Tất cả issue của petercorke/robotics-toolbox-python

Issue tương tự

Thêm issue về C++

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.