Skip to content

Commit

Permalink
docs: adjust the tone of the documentation
Browse files Browse the repository at this point in the history
Reword some sentences since words like obviously or easy can come
across as condescending.
  • Loading branch information
remigius42 committed Mar 11, 2024
1 parent 3d1c5d6 commit 1b300fb
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,8 @@ console.log("x = " + xAnswer) // x = undefined

### Parser

Use `algebra.parse` to parse expressions and equations from strings.
To parse expressions, equations and inequations from strings, you can either use
`algebra.parse` or `new algebra.Parser.parse()`.

#### Parse Expressions

Expand Down Expand Up @@ -466,8 +467,9 @@ const ans = eq.solveFor("x")

## LaTeX

Make things pretty with LaTeX. The `algebra` object has a `.toTex()` method for rendering LaTeX. Combining this with
[KaTeX](https://github.com/Khan/KaTeX), for example, is easy.
The `algebra` object has a `.toTex()` method for rendering LaTeX, which can be
combined with libraries like [KaTeX](https://github.com/Khan/KaTeX) or
[MathJax](https://docs.mathjax.org/en/latest/index.html).

### Example

Expand Down Expand Up @@ -510,7 +512,7 @@ katex.render("x = " + toTex(answers), mySolution);

## Greek Letters

Also supports Greek letters, obviously!
Greek letters are supported as well:

```html
<div>
Expand Down

0 comments on commit 1b300fb

Please sign in to comment.