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 docstring to plugin

Browse source
This commit is contained in:
Jakub Trllo 2022-07-14 13:38:40 +02:00
parent 9c1dd8b5ca
commit 36ae9ff49c
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
openpype/hosts/traypublisher/plugins/publish/collect_simple_instances.py
View file

@ -7,7 +7,21 @@ import pyblish.api
class CollectSettingsSimpleInstances(pyblish.api.InstancePlugin):
"""Collect data for instances created by settings creators."""
"""Collect data for instances created by settings creators.
Plugin create representations based on 'filepath' attribute stored
on instance.
Representations can be marked for review and in that case is also added
'review' family to instance families. For review can be marked only one
representation so **first** representation that has extension available
in '_review_extensions' is used for review.
For 'source' on instance is used path from last created representation.
Set staging directory on instance. That is probably never used because
each created representation has it's own staging dir.
"""
label = "Collect Settings Simple Instances"
order = pyblish.api.CollectorOrder - 0.49