glideapps/quicktype

Generate correct comment for Ruby top-level enum

Open

#724 opened on Apr 1, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (10,867 stars) (968 forks)batch import
Rubygood first issue

Description

We don't generate helpers for top-level enums, but the usage comment is written as if we did. Either generate them, or fix the comment. The test file is tests/input/schema/top-level-enum.schema.

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The test file is `tests/input/schema/top level enum.schema`. Examine the Ruby code generation logic to understand how comments are generated for enums. Check whether helpers are generated for top level enums and adjust the comment accordingly. If helpers are not generated, fix the comment to not claim they are. Alternatively, implement helper generation for top level enums.
Generate correct comment for Ruby top-level enum · glideapps/quicktype#724 | Good First Issue