add some details to field/group/scalar doc #267
Conversation
bendyarm
requested review from
acoglio,
moAlobaidi,
howardwu,
collinc97 and
d0cd
| ```aleo | ||
| function main: | ||
| input r0: field.private; | ||
| ``` | ||
|
|
||
| ### Group Elements | ||
|
|
There was a problem hiding this comment.
Actually not directly related to the changes in this PR, but since we have just one elliptic curve at the moment,
we could change the sentence just below to omit 'passed into the Aleo instructions compiler'.
Co-authored-by: Alessandro Coglio <[email protected]> Signed-off-by: Eric McCarthy <[email protected]>
There was a problem hiding this comment.
@bendyarm Technically on PTO rn, but ran this locally and HTML renders correctly. LGTM!
There was a problem hiding this comment.
My comments re-add double spaces at the end of lines in markdown.
This is desired because it starts the next sentence on a new line in the documentation - improving readability.
I believe your editor removes double spaces at the end of a line @bendyarm. Please address the changes and disable the feature in your editor in the future.
|
@collinc97 Thanks for catching that. |
In order for a developer to know what their code is supposed to do, it helps to know the
exact spec of the language. For field and scalar values, it helps to know the allowed values.
For the group, the definition of
+in terms of coordinates would be too verbose here,but at least stating that it is a Twisted Edwards curve with specific
aanddwill letsomeone look up the details and do the calculations. Also specified the generator point.
I do not have the environment to make sure the html builds right, so I am hoping a reviewer
can check that before merging this branch.