Make output more readable

Open
#3 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
Needs clarification
Activity status
Stale
Tech stack
markdown
Domain
cli

Research direction

Start by finding the interactive-mode output path and the Markdown rendering for headings and code blocks. Review the listed readability options, then define which coloring and screen-clearing behaviors are in scope and verify the resulting output interactively.

Written by the indexing model from the issue text.

Description

Currently output is hard to read as it is essentially a wall of text. Here are some things we could do to make it more readable in interactive mode:

  • Clear the screen on each user keypress with print(colorama.ansi.clear_screen()) (potentially make it optional since some users may want to scroll backwards.
  • Colorize the request for user interaction in order to differentiate it (perhaps grey)
  • Colorize code blocks, ideally this will be syntax colored but event changing the background and font colour will help
  • Colorize headings
  • Colorize output vs documentation
  • ???
Dominant language
Go
Stars
40
Forks
27
Avg merge
2d 20h
Merged PRs (30d)
1

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 Azure/InnovationEngine

All issues in Azure/InnovationEngine

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.