ezyang / ezyang/logitext

Explain what syntax is allowed somewhere on the site

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

Nobody has claimed this yet.

Dominant language
UrWeb
Stars
155
Forks
12
PR merge metrics
No merged PRs in 30d

Description

The site does not seem to explain what syntax Logitext expects, and the parse error message does not indicate what was wrong with the input.

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

Review the site's existing documentation and locate the code that produces the parse error. Determine what Logitext syntax the site accepts and which input problems the error should explain. Done means the allowed syntax is documented somewhere on the site and the parse error gives useful guidance about invalid input.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.