Skip to content

Commit f2e9f1a

Browse files
authored
Docs/gh 221 format and hack (#240)
* Restructured content and added the workaround for reserved terms. * GH-221 Actioned Peter's comments in #222. * GH-221 Refactored README to separate implicit multiplication * Added note about #223 in the docs * Actioned comments
1 parent b4312c6 commit f2e9f1a

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

app/docs/user.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -611,32 +611,45 @@ If you want to use a symbol that is usually reserved for some reserved character
611611
1. Create an input symbol where the code is different that the symbol you want to use, e.g. ‘Ef’ or 'Euler' instead of ‘E’
612612
2. Add the symbol you want to use as an alternative, e.g. the alternatives could be set to ‘E’
613613

614+
See note in [`convention`](#convention) for the limitations of using multi character symbols and implicit multiplication higher precedence.
615+
614616
#### Example:
615617
For the answer:
616-
$A/(E*l)$, $E$ is reserved, so we replace $E$ with $ef$ and provide alternatives as input symbols:
618+
$A/(\epsilon*l)$, `e` is reserved as Euler's number, so we replace `e` with `ef` or any other character(s) that are not reserved or used in the expression and provide alternatives as input symbols:
617619

618-
Symbol: $ϵ$
620+
Symbol: $\epsilon$
619621

620622
Code: `ef`
621623

622624
Alternatives: `ϵ,ε,E,e,Ep`
623625

624-
Here the answer $A/(E*l)$ is marked as correct.
626+
Here the answer $A/(ef*l)$ is marked as correct, and so are the alternatives:
627+
- $A/(ϵ*l)$
628+
- $A/(ε*l)$
629+
- $A/(E*l)$
630+
- $A/(e*l)$
631+
- $A/(Ep*l)$
632+
625633

626634

627-
### Reserved Characters and Implicit Multiplication
628-
As implicit multiplication cannot decypher what is a multi-character code and what are two variables that should be multiplied, single letter codes should be used.
629635

630636
#### Example
637+
As implicit multiplication with higher precedence cannot decypher what is a multi-character code and what are two variables that should be multiplied (see [`convention`](#convention) for more detail), single letter codes should be used.
631638
With `"convention": "implicit_higher_precedence"` set
632639

633640
For the answer:
634-
$A/(E*l)$ $E$ is reserved, so we replace $E$ with $b$ and provide alternatives as input symbols:
635-
Symbol: ϵ
641+
$A/(\epsilon*l)$, `e` is reserved as Euler's number, so we replace `e` with `b` or any other character(s) that are not reserved or used in the expression and provide alternatives as input symbols:
642+
Symbol: $\epsilon$
636643
Code: b
637644
Alternatives: ϵ,ε,E,e,Ep
638645

639-
Here the answer A/El is marked as correct.
646+
Here the following are marked as correct:
647+
- $A/(b*l)$ or $A/(bl)$ or $A/bl$
648+
- $A/(ϵ*l)$ or $A/(ϵl)$ or $A/ϵl$
649+
- $A/(ε*l)$ or $A/(εl)$ or $A/εl$
650+
- $A/(E*l)$ or $A/(El)$ or $A/El$
651+
- $A/(e*l)$ or $A/(el)$ or $A/e*l$
652+
- $A/(Ep*l)$ or $A/(Epl)$ or $A/Epl$
640653

641654
### Overriding greek letters or other reserved symbols with input symbols
642655

0 commit comments

Comments
 (0)