QPQ-AG/sophia
10
0
Fork 0
Code Issues 41 Pull Requests 5 Actions Packages Projects Releases 16 Wiki Activity

Merge pull request #262 from aeternity/fix_types

Browse Source 
Fix AENS types + whitespace
This commit is contained in:
Hans Svensson 2020-05-27 08:10:18 +02:00 committed by GitHub
commit 9753f90034
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/sophia_stdlib.md
View File

@ -501,7 +501,7 @@ using the private key of the `owner` account for signing.
### transfer ### transfer
``` ```
AENS.transfer(owner : address, new_owner : address, name_hash : hash, <signature : signature>) : unit AENS.transfer(owner : address, new_owner : address, name : string, <signature : signature>) : unit
``` ```
Transfers name to the new owner. Transfers name to the new owner.
@ -512,7 +512,7 @@ using the private key of the `owner` account for signing.
### revoke ### revoke
``` ```
AENS.revoke(owner : address, name_hash : hash, <signature : signature>) : unit AENS.revoke(owner : address, name : string, <signature : signature>) : unit
``` ```
Revokes the name to extend the ownership time. Revokes the name to extend the ownership time.
@ -1149,7 +1149,7 @@ will yield `None`.
### choose ### choose
``` ```
Option.choose(o1 : option('a), o2 : option('a)) : option('a) Option.choose(o1 : option('a), o2 : option('a)) : option('a)
``` ```
Out of two `option`s choose the one that is `Some`, or `None` if both are `None`s. Out of two `option`s choose the one that is `Some`, or `None` if both are `None`s.
@ -1261,7 +1261,7 @@ Func.curry2(f : ('a, 'b) => 'c) : 'a => ('b => 'c)
Func.curry3(f : ('a, 'b, 'c) => 'd) : 'a => ('b => ('c => 'd)) Func.curry3(f : ('a, 'b, 'c) => 'd) : 'a => ('b => ('c => 'd))
``` ```
Turns a function that takes n arguments into a curried function that takes Turns a function that takes n arguments into a curried function that takes
one argument and returns a function that waits for the rest in the same one argument and returns a function that waits for the rest in the same
manner. For instance `curry2((a, b) => a + b)(1)(2) == 3`. manner. For instance `curry2((a, b) => a + b)(1)(2) == 3`.
@ -1631,7 +1631,7 @@ This namespace provides operations on rational numbers. A rational number is rep
as a fraction of two integers which are stored internally in the `frac` datatype. as a fraction of two integers which are stored internally in the `frac` datatype.
The datatype consists of three constructors `Neg/2`, `Zero/0` and `Pos/2` which determine the The datatype consists of three constructors `Neg/2`, `Zero/0` and `Pos/2` which determine the
sign of the number. Both values stored in `Neg` and `Pos` need to be strictly positive sign of the number. Both values stored in `Neg` and `Pos` need to be strictly positive
integers. However, when creating a `frac` you should never use the constructors explicitly. integers. However, when creating a `frac` you should never use the constructors explicitly.
Instead of that, always use provided functions like `make_frac` or `from_int`. This helps Instead of that, always use provided functions like `make_frac` or `from_int`. This helps
keeping the internal representation well defined. keeping the internal representation well defined.
@ -1767,14 +1767,14 @@ Rounds a fraction to the nearest greater or equal integer.
### round_to_zero ### round_to_zero
`Frac.round_to_zero(f : frac) : int` `Frac.round_to_zero(f : frac) : int`
Rounds a fraction towards zero. Rounds a fraction towards zero.
Effectively `ceil` if lesser than zero and `floor` if greater. Effectively `ceil` if lesser than zero and `floor` if greater.
### round_from_zero ### round_from_zero
`Frac.round_from_zero(f : frac) : int` `Frac.round_from_zero(f : frac) : int`
Rounds a fraction from zero. Rounds a fraction from zero.
Effectively `ceil` if greater than zero and `floor` if lesser. Effectively `ceil` if greater than zero and `floor` if lesser.
@ -1806,7 +1806,7 @@ Subtraction of two fractions.
### inv ### inv
`Frac.inv(a : frac) : frac` `Frac.inv(a : frac) : frac`
Inverts a fraction. Throws error if `a` is zero. Inverts a fraction. Throws error if `a` is zero.
### mul ### mul