Skip to content

Commit

Permalink
Update the docstrings in the cmds module
Browse files Browse the repository at this point in the history
  • Loading branch information
krathjen committed Jan 23, 2018
1 parent deb1e50 commit f42a340
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions cmds.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ def itemClasses():

def itemExtensions():
"""
Register the given item class to the given extension.
Return all the registered item extensions.
:rtype: list[str]
"""
Expand All @@ -161,7 +161,7 @@ def itemExtensions():

def clearItemClasses():
"""
Remove all registered item class.
Remove all registered item classes.
:rtype: None
"""
Expand Down Expand Up @@ -238,7 +238,7 @@ def pathsFromUrls(urls):

def isValidItemPath(path):
"""
Return True if the given path is supported by a registered items.
Return True if the given path is supported by a registered item.
:type path: str
:rtype: bool
Expand All @@ -248,7 +248,7 @@ def isValidItemPath(path):

def itemClassFromPath(path):
"""
Return the registered LibraryItemClass that supports the given path.
Return the registered LibraryItem class that supports the given path.
:type path: str
:rtype: studiolibrary.LibraryItem.__class__ or None
Expand Down Expand Up @@ -373,7 +373,7 @@ def localPath(*args):

def formatPath(formatString, path="", **kwargs):
"""
Resolve the given destination path.
Resolve the given string with the given path and kwargs.
Example:
print formatPath("{dirname}/meta.json", path="C:/hello/world.json")
Expand Down

0 comments on commit f42a340

Please sign in to comment.