starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-05-21 14:27:07 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Known usages/subtypes missing in pkl-doc model version 2 #349

New Issue
Closed
opened 2025-12-30 01:23:44 +01:00 by adam · 3 comments
adam commented 2025-12-30 01:23:44 +01:00
Owner
Copy Link
Copy Source

Originally created by @sin-ack on GitHub (Oct 8, 2025).

It seems #1169 introduced a typo here:

https://github.com/apple/pkl/blob/55eac2088b756ce83b185aff6b5230dfe6378aeb/pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeData.kt#L159

This should be using copy, otherwise all data is dropped. This is preventing pkl-doc from generating known subtypes/usages in class pages.

Originally created by @sin-ack on GitHub (Oct 8, 2025). It seems #1169 introduced a typo here: https://github.com/apple/pkl/blob/55eac2088b756ce83b185aff6b5230dfe6378aeb/pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeData.kt#L159 This should be using `copy`, otherwise all data is dropped. This is preventing `pkl-doc` from generating known subtypes/usages in class pages.
adam added the bug label 2025-12-30 01:23:44 +01:00
adam closed this issue 2025-12-30 01:23:44 +01:00
adam commented 2025-12-30 01:23:45 +01:00
Author
Owner
Copy Link
Copy Source

@sin-ack commented on GitHub (Oct 8, 2025):

Additionally, there's addKnownUsages missing here which also prevents usages from being included in the JSON file:

https://github.com/apple/pkl/blob/55eac2088b756ce83b185aff6b5230dfe6378aeb/pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeDataGenerator.kt#L211-L216

@sin-ack commented on GitHub (Oct 8, 2025): Additionally, there's `addKnownUsages` missing here which also prevents usages from being included in the JSON file: https://github.com/apple/pkl/blob/55eac2088b756ce83b185aff6b5230dfe6378aeb/pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeDataGenerator.kt#L211-L216
adam commented 2025-12-30 01:23:45 +01:00
Author
Owner
Copy Link
Copy Source

@sin-ack commented on GitHub (Oct 9, 2025):

One more, this is causing known usages to be added to known subtypes on subsequent runs of pkldoc on the same output directory:

https://github.com/apple/pkl/blob/55eac2088b756ce83b185aff6b5230dfe6378aeb/pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeData.kt#L131

@sin-ack commented on GitHub (Oct 9, 2025): One more, this is causing known usages to be added to known subtypes on subsequent runs of `pkldoc` on the same output directory: https://github.com/apple/pkl/blob/55eac2088b756ce83b185aff6b5230dfe6378aeb/pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeData.kt#L131
adam commented 2025-12-30 01:23:46 +01:00
Author
Owner
Copy Link
Copy Source

@bioball commented on GitHub (Oct 16, 2025):

Thanks for this!

@bioball commented on GitHub (Oct 16, 2025): Thanks for this!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
duplicate
enhancement
good first issue
help wanted
pull-request
Mirrored from GitHub Pull Request
No Label bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pkl#349
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?