Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add dedicated markdown docs for ApproximateEquality #153

Open
markuswntr opened this issue Sep 3, 2020 · 1 comment
Open

Add dedicated markdown docs for ApproximateEquality #153

markuswntr opened this issue Sep 3, 2020 · 1 comment
Labels
documentation Improvements to documentation good first issue Good for newcomers

Comments

@markuswntr
Copy link
Contributor

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
@markuswntr markuswntr mentioned this issue Sep 3, 2020
Merged
@stephentyrone stephentyrone changed the title Add documentation for Approximate Equality Add dedicated markdown docs for ApproximateEquality Sep 3, 2020
@stephentyrone
Copy link
Member

Updated title; we have a sketch of header doc already (which can be improved), but what I really want an issue for is a markdown doc that gives a general introduction and lots of examples.

@stephentyrone stephentyrone added documentation Improvements to documentation good first issue Good for newcomers labels Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@stephentyrone @markuswntr