WebAssembly / WebAssembly/WASI
Confusing formatting for bit flags
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 5.8k
- Forks
- 333
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 3
Description
While this looks fine in ASCII, the markdown rendering of bitflags confusingly places the flag number at the outer indent, for example drawing confusion as to whether the first is not a flag.
This confusion is easy if you don't click around to see what Record means (Rights was retyped from saying rights: Flags(u64) to rights: Record) or scroll to the bottom to notice all the items have an outdented bit number.
I think choosing another way to indicate the bit number that doesn't look weird in GitHub rich view will eliminate this.
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 locating the bitflags and Record formatting in the repository, then compare the ASCII presentation with GitHub's rich Markdown rendering shown in the issue. The work is done when the bit number no longer appears at an outer indent or otherwise suggests that the first item is not a flag.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100