improve docs

dlang · Feb 12, 2023 · a6c2326 · a6c2326
1 parent 5925682
commit a6c2326
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/source/dub/recipe/packagerecipe.d b/source/dub/recipe/packagerecipe.d
@@ -38,7 +38,8 @@ string[] getSubPackagePath(string package_name) @safe pure
 }
 
 /**
-	Returns the name of the top level package for a given (sub) package name.
+	Returns the name of the top level package for a given (sub) package name of
+	format `"basePackageName"` or `"basePackageName:subPackageName"`.
 
 	In case of a top level package, the qualified name is returned unmodified.
 */
@@ -48,7 +49,8 @@ string getBasePackageName(string package_name) @safe pure
 }
 
 /**
-	Returns the qualified sub package part of the given package name.
+	Returns the qualified sub package part of the given package name of format
+	`"basePackageName:subPackageName"`, or empty string if none.
 
 	This is the part of the package name excluding the base package
 	name. See also $(D getBasePackageName).