[PR #1241] [MERGED] pkldoc fixes #959

Closed
opened 2025-12-30 01:27:58 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/apple/pkl/pull/1241
Author: @bioball
Created: 10/16/2025
Status: Merged
Merged: 10/16/2025
Merged by: @bioball

Base: mainHead: pkldoc-fixes


📝 Commits (4)

  • bf88300 Fix generation of runtime data
  • 537a7c0 Re-generate output
  • c068b53 Run spotless apply
  • 8355396 Re-generate output for DocMigratorTest

📊 Changes

56 files changed (+522 additions, -85 deletions)

View changed files

📝 pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeData.kt (+14 -14)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeDataGenerator.kt (+12 -17)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/baseModule/index.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classInheritance/MyClass1.json (+16 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classInheritance/MyClass2.json (+12 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classMethodTypeReferences/MyClass.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classPropertyTypeReferences/MyClass.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classTypeConstraints/Address.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleMethodComments/index.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleMethodTypeReferences/MyClass.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/modulePropertyAnnotations/UserDefinedAnnotation.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/modulePropertyComments/index.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/modulePropertyTypeReferences/MyClass.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleTypes1/index.json (+12 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleTypes2/index.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/shared/MyClass.json (+16 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/typealiases/Person.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/typealiases/index.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package2/4.5.6/index.json (+8 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/run-2/data/com.package1/1.2.3/baseModule/index.json (+8 -1)

...and 36 more files

📄 Description

Fixes an issue where known subtype/usage information is not gathered.

Also: change class RuntimeData to not return pairs for better composability.

Closes https://github.com/apple/pkl/issues/1229


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/apple/pkl/pull/1241 **Author:** [@bioball](https://github.com/bioball) **Created:** 10/16/2025 **Status:** ✅ Merged **Merged:** 10/16/2025 **Merged by:** [@bioball](https://github.com/bioball) **Base:** `main` ← **Head:** `pkldoc-fixes` --- ### 📝 Commits (4) - [`bf88300`](https://github.com/apple/pkl/commit/bf883001fec2ba94d0bcc15fcc6f8dafc8713e51) Fix generation of runtime data - [`537a7c0`](https://github.com/apple/pkl/commit/537a7c061375811a37f30477ad50f531c14f290f) Re-generate output - [`c068b53`](https://github.com/apple/pkl/commit/c068b536137de0c0b50c52f0dc85b802174819bd) Run spotless apply - [`8355396`](https://github.com/apple/pkl/commit/835539695daafa3168e578e2d020983f7852d7aa) Re-generate output for DocMigratorTest ### 📊 Changes **56 files changed** (+522 additions, -85 deletions) <details> <summary>View changed files</summary> 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeData.kt` (+14 -14) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/RuntimeDataGenerator.kt` (+12 -17) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/baseModule/index.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classInheritance/MyClass1.json` (+16 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classInheritance/MyClass2.json` (+12 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classMethodTypeReferences/MyClass.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classPropertyTypeReferences/MyClass.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/classTypeConstraints/Address.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleMethodComments/index.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleMethodTypeReferences/MyClass.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/modulePropertyAnnotations/UserDefinedAnnotation.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/modulePropertyComments/index.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/modulePropertyTypeReferences/MyClass.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleTypes1/index.json` (+12 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/moduleTypes2/index.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/shared/MyClass.json` (+16 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/typealiases/Person.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package1/1.2.3/typealiases/index.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-1/data/com.package2/4.5.6/index.json` (+8 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/run-2/data/com.package1/1.2.3/baseModule/index.json` (+8 -1) _...and 36 more files_ </details> ### 📄 Description Fixes an issue where known subtype/usage information is not gathered. Also: change class `RuntimeData` to not return pairs for better composability. Closes https://github.com/apple/pkl/issues/1229 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 01:27:58 +01:00
adam closed this issue 2025-12-30 01:27:58 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pkl#959