Minor changes to docstrings

This commit is contained in:
Nocturn9x 2022-01-31 15:06:43 +01:00
parent 5e4aed7e0f
commit a0a49874bb
2 changed files with 5 additions and 6 deletions

View File

@ -155,7 +155,7 @@ proc removeDirectory*(directory: Directory) =
proc parseFileSystemTable*(fstab: string): seq[Filesystem] =
## Parses the contents of the given filesystem table and returns a Filesystem object.
## Parses the contents of the given filesystem table and returns a list of Filesystem objects.
## An improperly formatted or semantically invalid fstab will cause this function to
## error out with a ValueError exception that should be caught by the caller.
## No other checks other than very basic syntax are performed, as that job

View File

@ -108,11 +108,10 @@ proc resolve(logger: Logger, node: Service): seq[Service] =
## sorted list such that a service appears in it only
## after all of its dependencies and only
## before all of its dependents.
## This function also automatically handles
## detached subgraphs, which can occurr if
## one or more dependencies have common
## dependencies/dependents between each other,
## but not with the rest of the graph. Nodes
## This function is called iteratively by resolveDependencies
## to handle detached subgraphs, which can occurr if one or
## more dependencies have common dependencies/dependents between
## each other, but not with the rest of the graph. Nodes
## that have no dependencies nor provide any
## service may be located anywhere in the list,
## as that does not invalidate the invariants