Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#773 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
22/100
Tipo de issue
Refactorización
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
python
Área
robotics

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
C++
Estrellas
3.5k
Forks
639
Merge medio
1 d 16 h
PR fusionados (30 d)
88

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de petercorke/robotics-toolbox-python

Todos los issues de petercorke/robotics-toolbox-python

Issues similares

Más issues de C++

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.