From 19ec23b8c89ac7f572b65e151b3c280d492bee27 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 9 Feb 2024 15:05:27 +0100 Subject: [PATCH 1/5] doc: fix issue #3002 in two docstrings --- src/proto_alpha/lib_protocol/contract_repr.mli | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/proto_alpha/lib_protocol/contract_repr.mli b/src/proto_alpha/lib_protocol/contract_repr.mli index cd07cae82ce9..ac50e01d41fb 100644 --- a/src/proto_alpha/lib_protocol/contract_repr.mli +++ b/src/proto_alpha/lib_protocol/contract_repr.mli @@ -77,12 +77,14 @@ val pp_short : Format.formatter -> t -> unit val encoding : t Data_encoding.t -(** [implicit_encoding] is an encoding for public key hashes that is - compatible with the [encoding] of contracts for implicit accounts. *) +(** [implicit_encoding] is an encoding for public key hashes + compatible with the [encoding] of contracts in the specific case + of implicit accounts. *) val implicit_encoding : Signature.Public_key_hash.t Data_encoding.t (** [originated_encoding] is an encoding for contract hashes that is - compatible with the [encoding] of contracts for originated accounts. *) + compatible with the [encoding] of contracts in the specific case + of originated accounts. *) val originated_encoding : Contract_hash.t Data_encoding.t (** [cases f g] exports the {!type-Data_encoding.case}s used to define -- GitLab From 8b0e8b8681d034e19cc2e1e3d1f40c96ac154500 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 26 Feb 2024 17:25:23 +0100 Subject: [PATCH 2/5] doc: fix broken link to poetry installer --- docs/developer/python_environment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/python_environment.rst b/docs/developer/python_environment.rst index 90499648326d..0f4e02da683d 100644 --- a/docs/developer/python_environment.rst +++ b/docs/developer/python_environment.rst @@ -103,7 +103,7 @@ Now verify that the correct version is called when running ``python``: :start-after: [print python version] :end-before: [verify python version] -Now, on to installing ``poetry``. We'll use `poetry's official installer `__: +Now, on to installing ``poetry``. We'll use `poetry's official installer `__: .. literalinclude:: install-python-debian-ubuntu.sh :language: shell -- GitLab From 1649941d81a60129bb0417f7d1e54f950f76b671 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 28 Feb 2024 17:26:21 +0100 Subject: [PATCH 3/5] doc: fix active symlink in docs/Makefile --- docs/Makefile | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 8323c1cab78c..0bb942c48a0d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -193,7 +193,6 @@ sphinx: install-dependencies (echo ':orphan:'; echo ''; cat ../CHANGES.rst) > CHANGES-dev.rst @$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) @ln -s active "$(BUILDDIR)/oxford" || true - @ln -s active "$(BUILDDIR)/paris" || true # pylint does not support pyproject.toml configuration for now # It is configured by ./.pylint.rc @@ -253,4 +252,4 @@ clean: @-rm -Rf "$(BUILDDIR)" linkcheck odoc.log @-rm -f $(ERRDOCEXE) $(RPCDOCEXE) $(P2PDOCEXE) @-rm -Rf api/errors.rst developer/metrics.csv user/node-config.json alpha/rpc.rst shell/rpc.rst shell/p2p_api.rst user/default-acl.json CHANGES-dev.rst - @-rm -Rf api/octez-*.html api/octez-*.txt paris/octez-*.html oxford/octez-*.html alpha/octez-*.html + @-rm -Rf api/octez-*.html api/octez-*.txt oxford/octez-*.html paris/octez-*.html alpha/octez-*.html -- GitLab From e5f540e41976e8833e632439a76f9fedd8336637 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 29 Feb 2024 13:16:49 +0100 Subject: [PATCH 4/5] doc: link to all address prefixes in howtouse --- docs/introduction/howtouse.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/introduction/howtouse.rst b/docs/introduction/howtouse.rst index 4baba1b7ae3c..5c4836cef981 100644 --- a/docs/introduction/howtouse.rst +++ b/docs/introduction/howtouse.rst @@ -459,8 +459,8 @@ Implicit Accounts and Smart Contracts In Tezos there are two kinds of accounts: *implicit accounts* and *smart contracts*. -- The implicit accounts are the addresses starting with *tz1*, *tz2*, - and *tz3* we have used up to now. They are created with a transfer +- The implicit accounts are the addresses starting with *tz1* + we have used up to now (or other :ref:`address prefixes ` starting with *tz*). They are created with a transfer operation to the account's public key hash. - Smart contracts have addresses starting with *KT1* and are created -- GitLab From de8ab6e1ca78c4107f0771931ae130c61b07a3b4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 4 Mar 2024 15:46:20 +0100 Subject: [PATCH 5/5] doc: add def of adopted protocol --- docs/protocols/naming.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/protocols/naming.rst b/docs/protocols/naming.rst index 3284d9f85cae..6e14122b0751 100644 --- a/docs/protocols/naming.rst +++ b/docs/protocols/naming.rst @@ -64,6 +64,8 @@ in-use and upcoming protocols: - other possible terms: "(new) protocol proposal", "current proposal" +* A protocol proposal that has successfully passed all the votes in the :doc:`voting process <../active/voting>` and is waiting for activation during the Adoption period: "voted protocol (proposal)". + External resources ------------------ -- GitLab