Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
Co-authored-by: Silvio Traversaro <silvio.traversaro@iit.it>
  • Loading branch information
flferretti and traversaro committed May 14, 2024
1 parent 5b44df6 commit 7fa1139
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/resolve_robotics_uri_py/resolve_robotics_uri_py.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,21 @@ def resolve_robotics_uri(
Args:
uri: The URI to resolve.
extra_path: Additional environment variable to look for the file.
package_dirs: A list of additional paths to look for the file.
Returns:
The absolute filename corresponding to the URI.
Raises:
FileNotFoundError: If no file corresponding to the URI is found.
Note:
In case `package_dirs` is not provided, the function will look for the file in the
default search paths specified by the environment variables in `SupportedEnvVars`.
If a given model searches for the meshes in `package://ModelName/meshes/mesh.stl`, and the
actual mesh is in `/usr/local/share/ModelName/meshes/mesh.stl`, the `package_dirs` should
contain `/usr/local/share`.
"""
package_dirs = package_dirs or ""
package_dirs = package_dirs if isinstance(package_dirs, list) else [package_dirs]
Expand Down

0 comments on commit 7fa1139

Please sign in to comment.