Leftovers for `docs/syntax.md`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with docs/syntax.md and review the discussion threads linked from pull request #117 for the grammar-ordering and import-behavior requirements. Revise the chapter for consistent grammar ordering, document imports, and improve wording and cohesion with the other chapters; the documentation should cover all three listed areas.
Written by the indexing model from the issue text.
Description
In #116, docs/syntax.md was created to specify a LambdaBuffers Frontend file. The chapter is a first draft, and needs improvement.
The remaining work is as follows:
- Rearranging grammar productions to be more consistent with internals: https://github.com/mlabs-haskell/lambda-buffers/pull/117#discussion_r1365086275
- Documenting behavior of imports: https://github.com/mlabs-haskell/lambda-buffers/pull/117#discussion_r1364915922
- General wording improvements / cohesiveness with other chapters.
- Dominant language
- Haskell
- Stars
- 32
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Getting set up
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.
More from mlabs-haskell/lambda-buffers
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
mlabs-haskell/lambda-buffers#296 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
mlabs-haskell/lambda-buffers#295 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
mlabs-haskell/lambda-buffers#294 ·
-
Dykstra HFOpen
Difficulty 4/5 3-5 days Newbie friendliness 35/100
mlabs-haskell/lambda-buffers#293 ·
-
Nix-free pathOpendevops
Difficulty 5/5 Over a week Newbie friendliness 25/100
mlabs-haskell/lambda-buffers#292 ·
All issues in mlabs-haskell/lambda-buffers
Similar issues
-
Preserve bind arrowOpen
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
alunduil/siren-json.hs#233 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 84/100
alunduil/network-arbitrary#180 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
jgm/asciidoc-hs#14 ·