workbenchdev / workbenchdev/Biblioteca
Asterisk in code interpreted as emphasis delimiter
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 69
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
In the following line, the asterisk in *err is incorrectly interpreted as an opening emphasis delimiter:
Does nothing if
errisNULL; iferris non-NULL, then*errmust beNULL.
See https://docs.gtk.org/glib/func.set_error_literal.html and its equivalent in Biblioteca.
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 reproducing the rendering problem with the quoted line and compare it with the linked GLib documentation and its Biblioteca equivalent. Trace how the documentation viewer handles the *err text; done means the asterisk is displayed literally and is no longer treated as an emphasis delimiter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100