apple / apple/pkl

Pkldoc: Module URI is cut off

Open
#754 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
Java
Stars
11.5k
Forks
402
Avg merge
1d 15h
Merged PRs (30d)
20

Description

Running
```
jbang run --main org.pkl.doc.Main "org.pkl-lang:pkl-doc:0.26.3" package://pkg.pkl-lang.org/github.com/stefma/pkl-gha/com.github.action@0.0.4 -o .out/doc
```

I got the following `Module URI` displayed:
Screenshot 2024-10-30 at 10 54 43 AM
There are a few characters just cut off 🤷

Also others are affected.
See https://jamesward.github.io/pklgha/pkg.pkl-lang.org/github.com/jamesward/pklgha/pklgha/current/ctionSwift/index.html

`ctionSwift` is even used in the URL instead of `GitHubActionSwift`.

Contributor guide

Open the contributing guide

Research direction

Run the reported `jbang run --main org.pkl.doc.Main` command and inspect the generated output under `.out/doc`. Compare the displayed Module URI and generated links with the full module names, including the `GitHubActionSwift` example; done means no characters are truncated and generated URLs retain the complete names.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.