quarto-dev / quarto-dev/quarto-cli
Document support code annotation comment chars
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
Following question at https://github.com/quarto-dev/quarto-cli/discussions/13540
I wonder if we should try add a callout collapsed by default at https://quarto.org/docs/authoring/code-annotation.html#annotation-syntax
and try to have its content synced to
https://github.com/quarto-dev/quarto-cli/blob/932e21ccea343aedd45db3557459dc9580a39b8c/src/resources/filters/modules/constants.lua#L75-L135
This would be an improvement. But we could also add a footnote (or margin note) for url to where to look in the code on github.
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 with the annotation syntax section at quarto.org/docs/authoring/code-annotation.html#annotation-syntax and compare it with the comment-character definitions in src/resources/filters/modules/constants.lua at the referenced lines. Decide whether the documentation should use a collapsed callout or a footnote/margin note, then ensure the supported comment characters and a link to the source are documented accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100