[PR #362] [MERGED] Fix source links in pkldoc #521

New Issue

Closed

opened 2025-12-30 01:25:06 +01:00 by adam · 0 comments

adam commented 2025-12-30 01:25:06 +01:00

Owner

Copy Link

Copy Source

📋 Pull Request Information

Original PR: https://github.com/apple/pkl/pull/362
Author: @bioball
Created: 3/25/2024
Status: ✅ Merged
Merged: 3/26/2024
Merged by: @bioball

Base: main ← Head: pkl-doc-fix-source-link

---

📝 Commits (2)

• b2be7df Fix source links in pkldoc
• 27f734e Avoid double encoding source code uri

📊 Changes

54 files changed (+77 additions, -69 deletions)

View changed files

📝 pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt (+1 -1)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt (+4 -8)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt (+5 -4)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt (+4 -3)
📝 pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt (+14 -4)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/Module Containing Spaces/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeAnnotations/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeReferences/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyAnnotations/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeAnnotations/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeReferences/index.html (+1 -1)
📝 pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html (+1 -1)

...and 34 more files

📄 Description

Fixes an issue where source links are incorrectly URI encoded; i.e. https%3A//github.com instead of https://github.com.

This was causing the browser to resolve these as relative to the enclosing page.

---

_{🔄 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/362 **Author:** [@bioball](https://github.com/bioball) **Created:** 3/25/2024 **Status:** ✅ Merged **Merged:** 3/26/2024 **Merged by:** [@bioball](https://github.com/bioball) **Base:** `main` ← **Head:** `pkl-doc-fix-source-link` --- ### 📝 Commits (2) - [`b2be7df`](https://github.com/apple/pkl/commit/b2be7dff383c61b81eb69d002c750a8c510de1d4) Fix source links in pkldoc - [`27f734e`](https://github.com/apple/pkl/commit/27f734e77a834dd4112b4f36e526015e5016edf4) Avoid double encoding source code uri ### 📊 Changes **54 files changed** (+77 additions, -69 deletions) <details> <summary>View changed files</summary> 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/DocGenerator.kt` (+1 -1) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/DocPackageInfo.kt` (+4 -8) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/DocScope.kt` (+5 -4) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/PageGenerator.kt` (+4 -3) 📝 `pkl-doc/src/main/kotlin/org/pkl/doc/Util.kt` (+14 -4) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/Module Containing Spaces/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/baseModule/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classAnnotations/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classComments/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classInheritance/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodComments/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodModifiers/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeAnnotations/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classMethodTypeReferences/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyAnnotations/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyComments/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyModifiers/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeAnnotations/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classPropertyTypeReferences/index.html` (+1 -1) 📝 `pkl-doc/src/test/files/DocGeneratorTest/output/com.package1/1.2.3/classTypeConstraints/index.html` (+1 -1) _...and 34 more files_ </details> ### 📄 Description Fixes an issue where source links are incorrectly URI encoded; i.e. `https%3A//github.com` instead of `https://github.com`. This was causing the browser to resolve these as relative to the enclosing page. --- _{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

adam added the pull-request label 2025-12-30 01:25:06 +01:00

adam closed this issue 2025-12-30 01:25:06 +01:00

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

dependabot/github_actions/gradle/actions/dependency-submission-6.2.0

release/0.32

dependabot/gradle/com.squareup-kotlinpoet-2.3.0

truffle-object-model-clean

release/0.31

release/0.30

release/0.29

release/0.28

release/0.27

release/0.26

release/0.25

0.32.1

0.32.0

0.31.1

0.31.0

0.30.2

0.30.1

0.30.0

0.29.1

0.29.0

0.28.2

0.28.1

0.28.0

0.27.2

0.27.1

0.27.0

0.26.3

0.26.2

0.26.1

0.26.0

0.25.3

0.25.2

0.25.1

0.25.0

Labels

Clear labels

bug

duplicate

enhancement

good first issue

help wanted

pull-request

Mirrored from GitHub Pull Request

No labels pull-request

Milestone

No items

No Milestone

Projects

Clear projects

No projects

Assignees

Clear assignees

adam (Adam Melkus)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/pkl#521