github/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2026-10-29 14:00:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

📚 Make variant docstrings independent of the callers

Browse Source 
The docstrings of generate-add-new-property and
generate-make-shapes-variant, and a comment in
generate-make-shapes-no-variant, described who calls them and how.
Say instead that they are part of a higher level operation, and that
the validation must run once the whole operation is complete.

AI-assisted-by: claude-opus-5-5
This commit is contained in:
Eva Marco 2026-10-02 12:28:22 +02:00 committed by Andrés Moya
parent 911dea8a4f
commit 2ba607cd5a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
common/src/app/common/logic/variant_properties.cljc
View File

@ -176,8 +176,8 @@
The editing? flag, if set, will be added to the metadata of the properties, for later use.
The skip-validation? flag is for callers that add the property while some shapes of the
container are not variants yet. They must validate the container themselves when done."
The skip-validation? flag is used when this function is part of a higher level operation.
The validation must be done after the whole operation is complete."
[changes variant-id & {:keys [fill-values? editing? property-name property-value skip-validation?]}]
(let [data (pcb/get-library-data changes)
objects (pcb/get-objects changes)
@ -247,7 +247,7 @@
(if (empty? shapes)
changes
;; Only the extracted main instances change. The container is not
;; validated, as the caller may not have moved the shapes out of it yet
;; validated because this is only a partial operation
(-> (reduce generate-make-shape-no-variant changes shapes)
(pcb/validate-shapes (pcb/get-page-id changes)
(mapv :id shapes)
@ -279,8 +279,8 @@
"Introduce some components into a variant, adding the variant-id and variant-name to the
main instances and the variant-id and variant-properties to the components.
It does not validate the shapes, as callers may run it before the shapes are inside the
container. The callers must validate the container when done."
It does not validate the shapes because this is only a partial operation. The validation
must be done after the whole operation is complete."
[changes shapes variant-container]
(let [data (pcb/get-library-data changes)
objects (pcb/get-objects changes)