Haddock does not show slashes in example

Open
  • Is something wrong?
#126 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
haskell
Domain
documentation

Research direction

Open the linked Haddock page and inspect the first example where choice slashes are rendered as italics. Trace that example back to its source in the repository and reproduce the rendering issue. Done means the example displays the choice slashes literally instead of treating them as italic markers.

Written by the indexing model from the issue text.

Description

https://hackage-content.haskell.org/package/cuddle-1.1.0.0/docs/Codec-CBOR-Cuddle-Huddle.html#v:-47-
The first snippet treats the slashes as italics signifiers and simply makes the text between the choice slashes italic.

Dominant language
Haskell
Stars
8
Forks
5
Avg merge
3d 12h
Merged PRs (30d)
4

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from IntersectMBO/cuddle

All issues in IntersectMBO/cuddle

Similar issues

More Haskell issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.