adobe / adobe/jsonschema2md

Render defaults as yaml when using --example-format yaml

Open
#246 0 comments 4 reactions 0 assignees View on GitHub
bug
Dominant language
JavaScript
Stars
724
Forks
150
Avg merge
18h 22m
Merged PRs (30d)
4

Description

Hey,
Pretty much as the title says we use `--example-format yaml` for the examples, but the defaults are still rendered as json. It'd be good if these were rendered as yaml too.

Screenshot 2020-08-30 at 09 43 26

Contributor guide

Open the contributing guide

Research direction

The issue does not identify a file, test, or entry point. Start by locating the handling for --example-format and the rendering of defaults, then check how JSON and YAML examples are generated. Done means defaults use YAML whenever --example-format yaml is selected, while other formats retain their existing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.