Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

added some docstrings to deprecated functions

Browse source
This commit is contained in:
Jakub Trllo 2022-08-29 14:41:44 +02:00
parent f2a191861b
commit ea241ca807
1 changed files with 20 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

31
openpype/lib/delivery.py
View file

@ -55,19 +55,23 @@ def deprecated(new_destination):
@deprecated("openpype.lib.path_tools.collect_frames")
def collect_frames(files):
"""
Returns dict of source path and its frame, if from sequence
"""Returns dict of source path and its frame, if from sequence
Uses clique as most precise solution, used when anatomy template that
created files is not known.
Uses clique as most precise solution, used when anatomy template that
created files is not known.
Assumption is that frames are separated by '.', negative frames are not
allowed.
Assumption is that frames are separated by '.', negative frames are not
allowed.
Args:
files(list) or (set with single value): list of source paths
Returns:
(dict): {'/asset/subset_v001.0001.png': '0001', ....}
Args:
files(list) or (set with single value): list of source paths
Returns:
(dict): {'/asset/subset_v001.0001.png': '0001', ....}
Deprecated:
Function was moved to different location and will be removed
after 3.16.* release.
"""
from .path_tools import collect_frames
@ -77,7 +81,12 @@ def collect_frames(files):
@deprecated("openpype.lib.path_tools.format_file_size")
def sizeof_fmt(num, suffix=None):
"""Returns formatted string with size in appropriate unit"""
"""Returns formatted string with size in appropriate unit
Deprecated:
Function was moved to different location and will be removed
after 3.16.* release.
"""
from .path_tools import format_file_size
return format_file_size(num, suffix)