unisonweb / unisonweb/website

Strange behaviour in docs

Open
#29 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
13
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Hi Again!

I found another issue in the docs that I wanted to try and fix while going through them, specifically at:
https://www.unison-lang.org/learn/fundamentals/control-flow/pattern-matching2/

Somewhere in the middle of the page, the snippet {Left} renders as Right (Term.Term (Any (_ a -> Left a))) which I thought was a little confusing and probably not the intended rendering. Looking at the code I wasn't able to find the issue until I started deleting prior paragraphs. It turns out that by removing Left a (in double-ticks) from the previous paragraph it magically fixes itself.

Hmmm... I'm completely stumped by that one - but hopefully this is useful to someone in tracking down the root cause.

All the best,
Tom

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Open the linked pattern-matching2 page and compare the rendering of {Left} with and without the preceding Left a text in backticks. Trace the documentation rendering path to find why the earlier snippet changes the later output; done means {Left} renders as intended without deleting the preceding text.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.