Update docs and bump to v0.4.0.

docs/src/conf.py

@@ -25,7 +25,7 @@
 author = 'Adam Heins'
 
 # The short X.Y version
-version = '0.3.0'
+version = '0.4.0'
 # The full version, including alpha/beta/rc tags
 release = version
 

package.xml

@@ -2,7 +2,7 @@
 <!-- Dummy package.xml so that ROS tools can identify this as a package. -->
 <package format="2">
   <name>xacrodoc</name>
-  <version>0.3.0</version>
+  <version>0.4.0</version>
   <description>Programmatically compile xacro files.</description>
   <maintainer email="mail@adamheins.com">Adam Heins</maintainer>
   <author>Adam Heins</author>

pyproject.toml

@@ -3,7 +3,7 @@ line-length = 80
 
 [tool.poetry]
 name = "xacrodoc"
-version = "0.3.0"
+version = "0.4.0"
 description = "Programmatically compile xacro files."
 authors = ["Adam Heins <mail@adamheins.com>"]
 license = "MIT"

src/xacrodoc/packages.py

@@ -4,6 +4,7 @@
 
 
 class PackageNotFoundError(Exception):
+    """Raised when a package could not be found."""
     pass
 
 
@@ -229,9 +230,14 @@ def get_file_path(pkg, relative_path):
 def update_package_cache(pkgpaths):
     """Update the package cache.
 
+    This allows the user to manually specify the location of packages on the
+    filesystem. The path does not actually need to be a proper ROS package,
+    meaning that there is no need to have a package.xml file there.
+
     Parameters
     ----------
     pkgpaths : dict
-        Map from package names to absolute package paths as strings.
+        Map from package names to package paths. The paths are resolved,
+        made absolute, and converted to strings.
     """
     _finder.update_package_cache(pkgpaths)