Skip to content

Commit 3b5dceb

Browse files
authored
Merge pull request #78 from lambda-feedback/docs/user-docs
Updated user docs to deprecate and link to compareExpressions
2 parents bc58ede + 776df27 commit 3b5dceb

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

app/docs/user.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# SymbolicEqual
2+
The function has been deprecated.
3+
4+
[compareExpressions](github.com/lambda-feedback/compareExpressions) is a second-generation evaluation function that is backwards compatible with symbolicEqual and provides more advanced capabilities.
25

36
This function utilises the [`SymPy`](https://docs.sympy.org/latest/index.html) to provide a maths-aware comparsion of a student's response to the correct answer. This means that mathematically equivalent inputs will be marked as correct. Note that `pi` is a reserved constant and cannot be used as a symbol name.
47

@@ -62,4 +65,4 @@ In general $\frac{\sqrt{a}}{\sqrt{b}} \neq \sqrt{\frac{a}{b}}$ but if $a > 0$ an
6265
So if expression like these are expected in the answer and/or response then it is a good idea to use the `symbol_assumptions` parameter to note that $a > 0$ and $b > 0$. This can be done by setting `symbol_assumptions` to `('a','positive') ('b','positive')`.
6366

6467
The example given in the example problem set uses an EXPRESSION response area that uses `SymbolicEqual` with answer `sqrt(a/b)`, `strict_syntax` set to false and `symbol_assumptions` set as above. Some examples of expressions that are accepted as correct:
65-
`sqrt(a)/sqrt(b)`, `(a/b)**(1/2)`, `a**(1/2)/b**(1/2)`, `(a/b)^(0.5)`, `a^(0.5)/b^(0.5)`
68+
`sqrt(a)/sqrt(b)`, `(a/b)**(1/2)`, `a**(1/2)/b**(1/2)`, `(a/b)^(0.5)`, `a^(0.5)/b^(0.5)`

0 commit comments

Comments
 (0)