apple/swift-numerics

Add dedicated markdown docs for ApproximateEquality

Open

#153 opened on Sep 3, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Swift (176 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,862 stars)
PR merge metrics
 (PR metrics pending)

Description

Write documentation for Approximate Equality and link document to README.md

See:

We should definitely link to detail on ApproximateEquality, but we should link to a markdown document, rather than the implementation. Let's remove this for now and open an issue to track adding one.

Originally posted by @stephentyrone in #150

Contributor guide

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.