Allow examples that don't parse

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Domain
cli

Research direction

No files, tests, or entry points are named. Start by locating the existing example parsing and rendering logic, then verify that verbatim examples are printed as written and template examples call their lambda with the path list, including the program name.

Written by the indexing model from the issue text.

Description

Currently we don't allow examples that don't parse.

We should add support for:

  • 'verbatim' (just print the example as is written)
  • 'template', where the example contains a lambda that is called with path (a list of super commands including the program name).
Dominant language
Toit
Stars
1
Forks
0
No merged PRs in 30d

Contributor guide

Open the contributing guide

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 toitlang/pkg-cli

All issues in toitlang/pkg-cli

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.