AndrasKovacs / AndrasKovacs/flatparse

Link to examples in hackage docs is broken

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

Nobody has claimed this yet.

Dominant language
Haskell
Stars
178
Forks
18
PR merge metrics
No merged PRs in 30d

Description

At this page: https://hackage.haskell.org/package/flatparse , there is a link to examples, but it appears to be broken.

Tutorial

Informative tutorials are work in progress. See src/FlatParse/Examples for a > lexer/parser example with acceptably good error messages.

That link ends up at https://hackage.haskell.org/package/flatparse-0.5.2.1/src/FlatParse/Examples, which only shows:

Page not found

Sorry, it's just not here.

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

Start at the flatparse Hackage page and locate the documentation source that produces the Tutorial link to src/FlatParse/Examples. Check the repository layout and package contents to find the current examples location, then update the link so it resolves to the available lexer/parser example and verify the rendered Hackage page no longer shows “Page not found”.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.