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

4
docs/modules/3_mapping/rectangle_fitting/rectangle_fitting_main.rst
View File

@@ -57,8 +57,8 @@ This evaluation function uses the squreed distances between the edges of the rec
Calculating the squared error is the same as calculating the variance.
The smaller this variance, the more it signifies that the points fit within the rectangle.
API
~~~~~~
Code Link
~~~~~~~~~~~
.. autoclass:: Mapping.rectangle_fitting.rectangle_fitting.LShapeFitting
:members: