Apply suggestions from code review

Adjustment to documentation, and families set declaration

Co-authored-by: Félix David <felixg.david@gmail.com>
This commit is contained in:
Sharkitty 2023-03-15 09:20:17 +00:00 committed by Sharkitty
parent 83aabf4c2b
commit 2022a38c65
2 changed files with 4 additions and 4 deletions

View file

@ -77,11 +77,11 @@ class IntegrateKitsuNote(pyblish.api.ContextPlugin):
if self.set_status_note and allow_status_change:
kitsu_status = gazu.task.get_task_status_by_short_name(
self.note_status_shortname
families = set(
families = {
instance.data.get("kitsu_task")
for instance in context
if instance.data.get("publish")
)
}
for instance in context:
kitsu_task = instance.data.get("kitsu_task")

View file

@ -44,10 +44,10 @@ Task status can be automatically set during publish thanks to `Integrate Kitsu N
`Admin -> Studio Settings -> Project Settings -> Kitsu -> Integrate Kitsu Note`.
There are four settings available:
- `Set status on note` -> turns on and off this integrator.
- `Set status on note` -> Turns on and off this integrator.
- `Note shortname` -> Which status shortname should be set automatically (Case sensitive).
- `Status conditions` -> Conditions that need to be met for kitsu status to be changed. You can add as many conditions as you like. There are two fields to each conditions: `Condition` (Whether current status should be equal or not equal to the condition status) and `Short name` (Kitsu Shortname of the condition status).
- `Family requirements` -> With this option you can add requirements to which families must be pushed or not in order to have the task status set by this integrator. There are two fields for each requirements: `Condition` (Same as the above) and `Family` (name of the family concerned by this requirement). For instance, adding one item set to `Not equal` and `workfile`, would mean the task status would change if a subset from another family than workfile is published (workfile can still be included), but not if you only publish the workfile subset.
- `Family requirements` -> With this option you can add requirements to which families must be pushed or not in order to have the task status set by this integrator. There are two fields for each requirements: `Condition` (Same as the above) and `Family` (name of the family concerned by this requirement). For instance, adding one item set to `Not equal` and `workfile`, would mean the task status would change if a subset from another family than workfile is published (workfile can still be included), but not if you publish the workfile subset only.
![Integrate Kitsu Note project settings](assets/integrate_kitsu_note_settings.png)