Skip to content

Commit

Permalink
improve docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
mokko committed Jun 9, 2024
1 parent 328a665 commit 255b7cf
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions src/mpapi/mink.py
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,11 @@ def chunk(

def getItem(self, module: str, ID: int) -> Module:
"""
gets a single items. Caches item on disk at
{project_dir}/{id}.xml
and makes new http request only if cache doesn't exist.
gets a single item and caches it on disk at
{project_dir}/getItem-{module}-{ID}.xml
Makes new http request only if cache doesn't exist. So you might need to delete
cache file manually.
"""
out_fn = self.project_dir / f"getItem-{module}-{ID}.xml"
if out_fn.exists():
Expand All @@ -148,8 +149,8 @@ def getPack(
since: Optional[str] = None,
) -> None:
"""
Download object and related information (attachment, media, people), join data
together and clean it.
Download object and related information (attachment, media, people), join,
validate and clean it.
"""
if label is None:
label = ""
Expand Down

0 comments on commit 255b7cf

Please sign in to comment.