FuelLabs/sway

Consider showing full output in `forc parse-bytecode` example

Open

#1,474 opened on May 4, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
The Sway Bookgood first issue

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 22h 6m) (16 merged PRs in 30d)

Description

Related: #1467

The updated example in the parse bytecode page uses the counter example which spits out a long output. For now this long output is manually truncated.

We can consider showing the full output if we want to, in case the example is unclear - ideally if we have some way to hide/show the output, as discussed here

Contributor guide

Research direction
Review the current documentation page for `forc parse bytecode`, check the output from the `counter` example, and decide whether to include the full output or implement a collapsible section. Look at the discussion in the linked PR for context.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85