Add dedicated markdown docs for ApproximateEquality
Open
documentation
good first issue
- Dominant language
- Swift
- Stars
- 1.9k
- Forks
- 181
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 6
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
Start by locating the ApproximateEquality implementation and the README.md link area. Add a dedicated Markdown document explaining Approximate Equality, then link that document from README.md and verify the links and documentation render correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100