mojolicious/mojo

Small introduction to promises

Open

#1,172 opened on Dec 19, 2017

View on GitHub
 (3 comments) (4 reactions) (0 assignees)Perl (591 forks)auto 404
docshelp wanted

Repository metrics

Stars
 (2,745 stars)
PR merge metrics
 (PR metrics pending)

Description

This is very similar to #1119, there is no real documentation in Mojo::Promise. I think it would be nice to explain at the least the basics of how to use promises, their possible states, what returning promises in the ->then(...) callbacks means and so on.

Contributor guide

Research direction
Research Mojo::Promise API and write documentation covering promise states, chaining with then(), error handling, and returning promises from callbacks.
Tech stack
perl
Domain
backenddocumentation
Issue type
Documentation
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PerlPromises
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60