Skip to content

Commit 8b83235

Browse files
committed
Minor fixes in documentation
1 parent ea84fa0 commit 8b83235

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

docs/requirements.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
alabaster==0.7.12; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
2-
atomicwrites==1.4.0; python_version >= "3.6" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.6" and python_full_version >= "3.4.0"
3-
attrs==21.4.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
2+
atomicwrites==1.4.0; python_version >= "3.7" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.4.0"
3+
attrs==21.4.0; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.7"
44
babel==2.9.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
55
black==22.1.0; python_full_version >= "3.6.2"
66
blockfrost-python==0.4.3; python_version >= "3.7" and python_version < "4"
@@ -9,35 +9,35 @@ certifi==2021.10.8; python_version >= "3.7" and python_full_version < "3.0.0" an
99
cffi==1.15.0; python_version >= "3.6"
1010
charset-normalizer==2.0.12; python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
1111
click==8.0.4; python_version >= "3.6" and python_full_version >= "3.6.2"
12-
colorama==0.4.4; sys_platform == "win32" and python_version >= "3.6" and python_full_version >= "3.6.2" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6") and platform_system == "Windows"
12+
colorama==0.4.4; sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.6.2" and (python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6") and platform_system == "Windows"
1313
coverage==6.3.2; python_version >= "3.7"
1414
decorator==5.1.1; python_version >= "3.5"
1515
docutils==0.17.1; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
1616
flake8==4.0.1; python_version >= "3.6"
1717
flask==2.0.3; python_version >= "3.6"
1818
idna==3.3; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
1919
imagesize==1.3.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
20-
importlib-metadata==4.2.0; python_version < "3.8" and python_version >= "3.6" and python_full_version >= "3.6.2"
21-
iniconfig==1.1.1; python_version >= "3.6"
20+
importlib-metadata==4.2.0; python_version < "3.8" and python_version >= "3.7" and python_full_version >= "3.6.2"
21+
iniconfig==1.1.1; python_version >= "3.7"
2222
isort==5.10.1; python_full_version >= "3.6.1" and python_version < "4.0"
23-
itsdangerous==2.1.0; python_version >= "3.7"
23+
itsdangerous==2.1.1; python_version >= "3.7"
2424
jinja2==3.0.3; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
2525
markupsafe==2.1.0; python_version >= "3.7"
2626
mccabe==0.6.1; python_version >= "3.6"
2727
mypy-extensions==0.4.3; python_full_version >= "3.6.2"
28-
packaging==21.3; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
28+
packaging==21.3; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.7"
2929
pathspec==0.9.0; python_full_version >= "3.6.2"
3030
platformdirs==2.5.1; python_version >= "3.7" and python_full_version >= "3.6.2"
31-
pluggy==1.0.0; python_version >= "3.6"
32-
py==1.11.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
31+
pluggy==1.0.0; python_version >= "3.7"
32+
py==1.11.0; python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.7"
3333
pycodestyle==2.8.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.5.0" and python_version >= "3.6"
3434
pycparser==2.21; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
3535
pyflakes==2.4.0; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
3636
pygments==2.11.2; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
3737
pynacl==1.5.0; python_version >= "3.6"
38-
pyparsing==3.0.7; python_version >= "3.6"
38+
pyparsing==3.0.7; python_version >= "3.7"
3939
pytest-cov==3.0.0; python_version >= "3.6"
40-
pytest==7.0.1; python_version >= "3.6"
40+
pytest==7.1.0; python_version >= "3.7"
4141
pytz==2021.3; python_version >= "3.6" and python_full_version < "3.0.0" or python_full_version >= "3.4.0" and python_version >= "3.6"
4242
requests==2.27.1; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_version >= "3.7" and python_version < "4" and python_full_version >= "3.6.0"
4343
retry==0.9.2
@@ -54,8 +54,8 @@ sphinxcontrib-serializinghtml==1.1.5; python_version >= "3.6" and python_full_ve
5454
tomli==2.0.1; python_version >= "3.7" and python_full_version >= "3.6.2"
5555
typed-ast==1.5.2; python_version < "3.8" and implementation_name == "cpython" and python_full_version >= "3.6.2" and python_version >= "3.6"
5656
typeguard==2.13.3; python_full_version >= "3.5.3"
57-
typing-extensions==4.1.1; python_version < "3.8" and python_full_version >= "3.6.2" and python_version >= "3.6"
57+
typing-extensions==4.1.1; python_version < "3.8" and python_full_version >= "3.6.2" and python_version >= "3.7"
5858
urllib3==1.26.8; python_version >= "3.7" and python_full_version < "3.0.0" and python_version < "4" or python_full_version >= "3.6.0" and python_version < "4" and python_version >= "3.7"
59-
websocket-client==1.2.3; python_version >= "3.6"
59+
websocket-client==1.3.1; python_version >= "3.6"
6060
werkzeug==2.0.3; python_version >= "3.6"
6161
zipp==3.7.0; python_version < "3.8" and python_version >= "3.7"

pycardano/plutus.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,9 +251,10 @@ def get_tag(constr_id: int) -> Optional[int]:
251251
@dataclass(repr=False)
252252
class PlutusData(ArrayCBORSerializable):
253253
"""
254-
PlutusData is the base class of all Datum and Redeemer type. It is not required to use this class in order to
255-
interact with Plutus script. However, inheriting datum(s) and redeemers in a PlutusData class will reduce the
256-
complexity of serialization and deserialization tremendously.
254+
PlutusData is a helper class that can serialize itself into a CBOR format, which could be intepreted as
255+
a data structure in Plutus scripts.
256+
It is not required to use this class to interact with Plutus scripts. However, wrapping datum in PlutusData
257+
class will reduce the complexity of serialization and deserialization tremendously.
257258
258259
Examples:
259260
@@ -429,6 +430,7 @@ def from_json(cls: PlutusData, data: str) -> PlutusData:
429430

430431

431432
Datum = Union[PlutusData, dict, IndefiniteList, int, bytes]
433+
"""Plutus Datum type. A Union type that contains all valid datum types."""
432434

433435

434436
def datum_hash(datum: Datum) -> DatumHash:

0 commit comments

Comments
 (0)