Documentation Links to ompl::base::SpaceInformationPtr when ompl::control::SpaceInformationPtr is Required
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 48/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- cpp
- Bereich
- documentation
Rechercherichtung
Beginne damit, die Dokumentation für die Klassenreferenzen von ompl::control::SimpleSetup, RRT und StatePropagator mit den Quelldeklarationen von OMPL zu vergleichen. Identifiziere die falschen Links zu ompl::base::SpaceInformationPtr, suche nach weiteren ähnlichen control-Referenzen und aktualisiere die Dokumentation, sodass jeder Konstruktor auf den erforderlichen control-Typ verweist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
In at least two different locations, the documentation features a link to the ompl::base::SpaceInformationPtr page. This suggests that an ompl::base::SpaceInformationPtr is sufficient for the code to work, but in reality, an inspection of the code shows that the child class, ompl::control::SpaceInformationPtr is what is really needed. This can lead to frustration as code that "should" work according to the documentation fails, because the wrong kind of SpaceInformationPtr is being used.
Cases where I know this is happening:
ompl::control::SimpleSetup Class Reference, where the first constructor expects the control::SpaceInformationPtr but the documentation links to the base version.
ompl::control::RRT Class Reference, where the constructor expects a control::SpaceInformationPtr but the documentation links to the base version.
ompl::control::StatePropagator Class Reference, where the second constructor expects a SpaceInformationPtr but the documentation links to the base version.
An elementary inspection of the OMPL source code is sufficient to see that the documentation does not match the source code, but unless the user already knows that the issue exists, they may not think about it and be stuck for some time. I suspect more cases of this sort exist, though I have not performed a thorough search of the documentation to verify.
- Vorherrschende Sprache
- C++
- Sterne
- 2.2k
- Forks
- 718
- Ø Merge
- 16 Std. 12 Min.
- Gemergte PRs (30 T.)
- 1
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus ompl/ompl
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 42/100
-
Possible [optimization] Does EITstar::isValidAtResolution re-calculate the same path excessively?Offen
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100
-
AORRTC always returns zero-length path on RealVectorStateSpace (OMPL 2.0.0 Python bindings)Evtl. vergeben @zkingston hat das vor 182 Tagen übernommen. Offen
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 55/100
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 80/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
eclipse-score/lifecycle#929 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
colbymchenry/codegraph#3223 ·
Maintainer antworten meist innerhalb von 1 Tag