Documentation Links to ompl::base::SpaceInformationPtr when ompl::control::SpaceInformationPtr is Required
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 48/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- cpp
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách so sánh tài liệu về các tham chiếu lớp ompl::control::SimpleSetup, RRT và StatePropagator với các khai báo mã nguồn của OMPL. Xác định các liên kết không chính xác đến ompl::base::SpaceInformationPtr, tìm kiếm các tham chiếu control tương tự khác và cập nhật tài liệu để mỗi hàm khởi tạo liên kết đến kiểu control bắt buộc.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- C++
- Star
- 2.2k
- Fork
- 718
- Merge trung bình
- 16 giờ 12 phút
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của ompl/ompl
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 42/100
-
Possible [optimization] Does EITstar::isValidAtResolution re-calculate the same path excessively?Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
-
AORRTC always returns zero-length path on RealVectorStateSpace (OMPL 2.0.0 Python bindings)Có thể đã có người làm @zkingston đã nhận 182 ngày trước. Đang mở
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 55/100
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 80/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
eclipse-score/lifecycle#929 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
colbymchenry/codegraph#3223 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
firefox-devtools/profiler#6436 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày