Purescript comments
Open
Nobody has claimed this yet.
kind/enhancement
- Dominant language
- TypeScript
- Stars
- 15.2k
- Forks
- 1.5k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 6
Description
Most Purescript packages rely on Pursuit to generate/read documentation and the comment syntax for that is -- | comment here rather than just -- comment. Running something like g q a p produces the wrong result for these comments.
-- | Long comment split
-- | across lines.
becomes something like
-- | Long comment split | across
-- lines
rather than the preferred
-- | Long comment split across
-- | lines
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the g q a p entry point and the comment-formatting logic it invokes. Reproduce the shown PureScript case, then verify that multiline -- | comments retain the marker on each generated line and that existing comment behavior remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100