Skip to content

Commit

Permalink
Fix abi-docs Sphinx warnings (#401)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaeldiamant authored Jun 17, 2022
1 parent d6e8501 commit 9e01761
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pyteal/ast/abi/array_dynamic.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ def set(
self,
values: Union[Sequence[T], "DynamicArray[T]", ComputedValue["DynamicArray[T]"]],
) -> Expr:
"""Set the ABI dynamic array with one of the following
"""Set the ABI dynamic array with one of the following:
* a sequence of ABI type variables
* or another ABI static array
* or a ComputedType with same TypeSpec
Expand All @@ -69,10 +70,15 @@ def set(
from ComputedType to store the internal ABI encoding into this StaticArray.
This function determines if the argument `values` is an ABI dynamic array:
* if so:
* checks whether `values` is same type as this ABI dynamic array.
* stores the encoding of `values`.
* if not:
* calls the inherited `set` function and stores `values`.
Args:
Expand Down
7 changes: 7 additions & 0 deletions pyteal/ast/abi/array_static.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ def set(
],
) -> Expr:
"""Set the ABI static array with one of the following:
* a sequence of ABI type variables
* or another ABI static array
* or a ComputedType with same TypeSpec
Expand All @@ -93,11 +94,17 @@ def set(
from ComputedType to store the internal ABI encoding into this StaticArray.
This function determines if the argument `values` is an ABI static array:
* if so:
* checks whether `values` is same type as this ABI staic array.
* stores the encoding of `values`.
* if not:
* checks whether static array length matches sequence length.
* calls the inherited `set` function and stores `values`.
Args:
Expand Down
2 changes: 2 additions & 0 deletions pyteal/ir/tealblock.py
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,10 @@ def MatchScratchSlotReferences(
A mapping is defined as follows:
* The actual and expected lists must have the same length.
* For every ScratchSlot referenced by either list:
* If the slot appears in both lists, it must appear the exact same number of times and at
the exact same indexes in both lists.
* If the slot appears only in one list, for each of its appearances in that list, there
must be a ScratchSlot in the other list that appears the exact same number of times
and at the exact same indexes.
Expand Down

0 comments on commit 9e01761

Please sign in to comment.