github/PythonRobotics
1
1
Fork 0
mirror of https://github.com/AtsushiSakai/PythonRobotics.git synced 2026-04-22 03:00:22 -04:00
Code Issues Packages Projects Releases Wiki Activity

Refactor module links and improve code documentation. (#1211)

Browse Source 
* Refactor module links and improve code documentation.

Updated documentation to rename "API" sections to "Code Link" for clarity and consistency. Enhanced docstrings for `circle_fitting` and `kmeans_clustering` functions, improving parameter descriptions and adding return value details. Fixed typos in function and file names in the ray casting grid map module.

* Fix import typo in ray casting grid map test module.

Corrected the import statement in the test file by updating the module's name to `ray_casting_grid_map` for consistency with the source file. This ensures proper functionality of the test suite.
This commit is contained in:
Atsushi Sakai
2025-05-03 09:25:12 +09:00
committed by GitHub
parent 22cbee4921
commit 5392fcff4d
13 changed files with 96 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/modules/3_mapping/normal_vector_estimation/normal_vector_estimation_main.rst
View File

@@ -25,8 +25,8 @@ This is an example of normal vector calculation:
.. figure:: normal_vector_calc.png
API
=====
Code Link
==========
.. autofunction:: Mapping.normal_vector_estimation.normal_vector_estimation.calc_normal_vector
@@ -67,8 +67,8 @@ This is an example of RANSAC based normal vector estimation:
.. figure:: ransac_normal_vector_estimation.png
API
=====
Code Link
==========
.. autofunction:: Mapping.normal_vector_estimation.normal_vector_estimation.ransac_normal_vector_estimation