thoughtbot/Argo

Document the use of the `alternate` operator

Open

#285 opened on Nov 4, 2015

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Swift (3,455 stars) (214 forks)batch import
documentationhelp wanted

Description

Related: #284

Our use of Alternative is something that sticks out to me as being insanely powerful, but we don't talk about it ever. We should add some documentation around this. Ideas:

  • Decoding multiple JSON formats
  • Decoding into enums rather than structs
  • Decoding from different JSON types (int/string as in #284)

Contributor guide

Tech stack
swift
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
Swift programmingfunctional programming basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the existing documentation and codebase for the `Alternative` operator. Refer to issue #284 for context. Write documentation covering the three use cases mentioned: decoding multiple JSON formats, decoding into enums, and decoding from different JSON types.