✨ Consider keeping doc comments in the parsed AST.
Nobody has claimed this yet.
- Dominant language
- Gleam
- Stars
- 81
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
I'm building some alternative docs for lustre and currently have to copy each definition + doc comment by hand into whatever I'm using to write/build docs. I thought about using glance to at least semi-automate this process but with no doc comments in the AST it's a non-starter for me.
I can see access to doc comments useful for other projects too, so maybe we could think about adding this in the future.
Contributor guide
No contributing guide indexed for this repository
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
No files, tests, or entry points are named. Start by locating the parser and AST definitions, then determine how doc comments could be retained alongside parsed definitions; done means the AST exposes the comments needed to generate alternative documentation.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100