From 8209f40a5346533b4c21ea9c5b6ba5295456582f Mon Sep 17 00:00:00 2001
From: iLLiCiTiT <jakub.trllo@gmail.com>
Date: Mon, 25 Oct 2021 14:08:21 +0200
Subject: [PATCH] initial docstrings of card view

---
 .../publisher/widgets/card_view_widgets.py    |  22 ++++++++++++++++++
 .../tools/publisher/widgets/images/minus.png  | Bin 0 -> 2796 bytes
 .../publisher/widgets/list_view_widgets.py    |   4 ++--
 3 files changed, 24 insertions(+), 2 deletions(-)
 create mode 100644 openpype/tools/publisher/widgets/images/minus.png

diff --git a/openpype/tools/publisher/widgets/card_view_widgets.py b/openpype/tools/publisher/widgets/card_view_widgets.py
index a4062fb5e3..07fdfd5bda 100644
--- a/openpype/tools/publisher/widgets/card_view_widgets.py
+++ b/openpype/tools/publisher/widgets/card_view_widgets.py
@@ -1,3 +1,25 @@
+"""Card view instance with more information about each instance.
+
+Instances are grouped under groups. Groups are defined by `creator_label`
+attribute on instance (Group defined by creator).
+
+Only one item can be selected at a time.
+
+```
+<i> == Icon (Can have Warning icon when context is not right)
++----------------------+
+|   Options            |
+| <Group 1> -----------|
+| <i> <Instance 1>  [x]|
+| <i> <Instance 2>  [x]|
+| ...                  |
+| <Group 2> -----------|
+| <i> <Instance 3>  [ ]|
+| ...                  |
++----------------------+
+```
+"""
+
 import re
 import collections
 
diff --git a/openpype/tools/publisher/widgets/images/minus.png b/openpype/tools/publisher/widgets/images/minus.png
new file mode 100644
index 0000000000000000000000000000000000000000..4d0d6f486ccae86a7cf310f4bbb80bacdab96631
GIT binary patch
literal 2796
zcmeHI`#aQW8^33aw2IPOw8LzddY9Uj$m>{0tFSAFm_v=zqE%UkH-{01>9q1{vO1xX
z)Dkl>Bn`tHHW%5gNcs|*F``_)NLF9kVP@X1>)QS4egA;{VV@s9&;4A_eLeU6e4fws
zd2$2%ybSco`T$_y<L$X0fQW}gSiTIOKBT=+0qEEJczOh<U7wOOD=X;7WiwhuvH8Bi
z_5TijeLBs%<II--+#<cWbmfxgYxCT4Meyn8`#n5XCwQ*@;<@P&vDGETL1x(*i{1#|
z!!uT%XV-X>dORaL)|;)ll~l0u;wh8Zx#X^~8~t~tGo;08b=Lcblk>H`Np;0z{jt?7
zu`b@l-{UXLfSFnBV?*W6US40Ym(VGU9x7^i#<11W#pN?Qgf#KaB(`9zh971xwQ-(`
z#v-sM_jJBJbp3AD0m|TOC&jcTJkg`^M}3YXT}T(w5_mOt4Y%2EgqNj3ND$J+PY7mF
z-9wLh-q~6Y41q%Ktr9wF$VASmcLjUR6Y1C~wEPgsHieLQ1XG~rQ5~*%7BHxf_yRhM
zHuSx(rEesU7*VbA#^w=I3-ljgZIMqe<x8HECYDufhWHu@L(D!Y0cGU;2x^D0^CqJU
zbY+9&T<sOzIRfY*V(xCGW!~XTHX%+@raFf0y5J6z$X0HM>W#4t+ilv2lTXv`S1Ya$
z>T;-anONOkTN{(YCsid_d!p8zmh<+71=yJJ+=A5}nETUj3zR$eLRg@hiD{hg>%#RR
zITB8j_WN&I*a|h(5?ZLVD-}2;8I7Xq^kjj-WQ>t=AENfrfK9`Msq@DQu|sX2J!CW4
z4Yno(@SVQbZjs?{uP}ajS?o*5tgSmVyfMt21gT@??ZyjQ@wJ>(CM*VGt>|x|ZhBzV
znTv)ZU+rK=IO@s@+A~}2n^)=sqva9Lly`@9Y}PMlW))RiJh}=@c(LTBbgzY($z&s?
zJ2ktm?<{b9TI$l{q6D1T0UyHqTy%Qw)74<ZWzin-H<V0QO!dO60Ji(!0#VjBdIojn
zHe@gd;tgbl7ZwT1$fU}G)~@kPU0EE$O)}7fqF=e(5J`E`K0?TT*P^&AJY_Bs>qXo8
zSB#MfANl{xhQ^nnLmlJND83QrG0%&~H(tL~&XPaD8*?aqb(EwG!g)yy2thigVu~pQ
zr{^CZyk8gONdn*3eMm#xfJIs=Njb8V^DLyhV<zT_F>JVMZ442+W8Qpx8U%E@w8&v;
zDG=PKtoMTWa6c=Md3KJb<DPT(yj@dPl)myZBH*=t^9kPY!>abNlcn<YgtTy617^uN
zrq0?YYh{$jdAd;ajACB_hK>%)8Z)bg0fL+YDF+f-G?u^X$c{F)h|<L_qDgO@K?)T>
zh6duGj~ng(fQyKxwphS7zHqLSs9izkQ6ENOrmhCrPv^G)L|~h7&|QlDFHo3#L%M&A
z<1S$6TJkncAXVs%&-HY`cjN~8qMasVS=+6Fi0v#|b%|yezZtoQ0J5KxdFgT3WczYi
zJt8bLSp_yH5*&|ZU6U?L>pK=n0E=T5eS$cb<0)9)coe?;O@-#VWRR4(=!x>vI$$-R
zQ{tydNhJhe;XUm{@EyHtCUr=f@x~6Pv_<1w<jqZ>1MThE)X?ootx4Ql$}Wo~(cRq^
zJRk37yMq{zascyALDm`(U<DSP5;~H<X!o5L@WKwST=&YsBLHNPY>_B?Zj`nO?DbFS
z@h40^HG<lJRrG}Fu<K%*1!LI{Cj2hz?HeIt*lp1G7ip&}v39r_*V!sPVBDXkW@pyq
z4Xy*n;30wGQ#(AZEUZ$|W1OTleQ=P}*ng4BS~leV=q7O5RMB_b7c#8zWU4#vL<;A8
zT=r*FW9aOl{Jwmx?1!%qHd6Y|^)rb0SwfY+Dk3@wN{qq&!6y=_=(_}4{0bi!QB#VZ
zK{;bA%OLSfe@6#Bm%5y#vz@y;x_5l7X=o<iM9a`k$T!WIhQK&iNN)PQOuqB}#XX$*
zESmbBs6lRmzxQHG0J}vsFL!IaW)Jo8Jk9NN#BBgz?rkyJifG@x8CI_ad&$<thD<wv
ziVulVo!V~P9fr&oz4$CDYr38S5i#%LM-{G?+JQkb=YS<&K$8x=#KpuomtCo;NY9cQ
zJiQH-=}mQk&!V_(CnOYr+1X624=E%&vxeSM;rp~&RUe8V%mFP~2N;L8(Zj1WEvn9)
zreV=1vzS;L`lm}GF}zZ%TQgfUyQNKm%Uk}m)V;5z2?Zs-bp>5)WCt&wmhb;;1B9IW
zEMfFl)_vt@cu!Y%_(8EybX&CxyPCV8$64{q3_5|7AdaR9z561I^FH+QS#)8kTMaYP
z3T!TW@tXZMxF7Zz>TCLuHojEq)j@HU=$=c<i?cUx@ZS|X3ws&G%@4-M`X{bU_oEVS
zwlpEWfM{~-kKg297c~Bb<nALT`w2F&)wX*Qlk-MWxZ|Xvhv`_3T6?vaJ1Qxel?!_}
zTWg|+x@{+-M=p=XT%j!gawK|W)A2_SoX$Jmna6*IzsFyifzBym?ALlh&%?`Xm-_VC
M<L6nkJL2Sj0U@EeKmY&$

literal 0
HcmV?d00001

diff --git a/openpype/tools/publisher/widgets/list_view_widgets.py b/openpype/tools/publisher/widgets/list_view_widgets.py
index d104e91bc8..e87ea3e130 100644
--- a/openpype/tools/publisher/widgets/list_view_widgets.py
+++ b/openpype/tools/publisher/widgets/list_view_widgets.py
@@ -1,7 +1,7 @@
 """Simple easy instance view grouping instances into collapsible groups.
 
-Groups are defined by `creator_label` attribute on instance (Group
-defined by creator).
+View has multiselection ability. Groups are defined by `creator_label`
+attribute on instance (Group defined by creator).
 
 Each item can be enabled/disabled with their checkbox, whole group
 can be enabled/disabled with checkbox on group or