From e639d654ebf200804869ab8dd3208a70e227a12d Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 29 Jun 2022 12:04:24 +0200 Subject: [PATCH 1/5] doc: request to document failures in Clic --- src/lib_clic/clic.mli | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/lib_clic/clic.mli b/src/lib_clic/clic.mli index 3d91842c38dc..f726d8764af8 100644 --- a/src/lib_clic/clic.mli +++ b/src/lib_clic/clic.mli @@ -577,6 +577,10 @@ val restore_formatter : Format.formatter -> formatter_state -> unit (** {2 Parsing and error reporting} *) +(* FIXME: #2935 Add documentation about failures in [Clic] + The documentation should mention what happens if the functions fail. +*) + (** Help error (not really an error), thrown by {!dispatch} and {!parse_global_options}. *) type error += Help : _ command option -> error -- GitLab From 9a63e75da49697430411b87771f28312fbce26f2 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 30 Jun 2022 16:26:00 +0200 Subject: [PATCH 2/5] doc: link to missing plugin RPCs --- docs/include/rpc_introduction.rst.inc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/include/rpc_introduction.rst.inc b/docs/include/rpc_introduction.rst.inc index 1c9bc2a0cdb9..39a5b023dd20 100644 --- a/docs/include/rpc_introduction.rst.inc +++ b/docs/include/rpc_introduction.rst.inc @@ -5,6 +5,10 @@ This page describes the RPCs specific to a particular version of the Tezos proto They are all served under the prefix ``/chains//blocks//``. To make the RPC reference more readable, this prefix is not repeated every time below, but instead shortened as ``../``. +.. warning:: + + Some dynamic or plugin RPCs are not listed here due to a current limitation in the documentation generator. They are listed in the :doc:`../api/openapi` (search the ``.json`` files that are linked from that page). + RPCs - Index ************ -- GitLab From a68ea88551d72109358492fc37888e1f63357fa4 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 30 Jun 2022 16:33:19 +0200 Subject: [PATCH 3/5] doc: fix title of page protocols/014*.rst --- docs/protocols/013_jakarta.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/protocols/013_jakarta.rst b/docs/protocols/013_jakarta.rst index 29f5ff66bc42..5bd8e358f14e 100644 --- a/docs/protocols/013_jakarta.rst +++ b/docs/protocols/013_jakarta.rst @@ -1,5 +1,5 @@ Protocol Jakarta -================== +================ **Important**: revision `PtJakarta...nGw` of protocol Jakarta contains `two critical bugs `_ -- GitLab From adfef5d9ae9b4f639ef5757e778a4f8b5cec74a5 Mon Sep 17 00:00:00 2001 From: Valentin Chaboche Date: Wed, 6 Jul 2022 13:54:13 +0200 Subject: [PATCH 4/5] Scoru: fix not-updated comment --- src/proto_alpha/lib_protocol/sc_rollup_PVM_sem.mli | 2 +- src/proto_alpha/lib_protocol/sc_rollup_inbox_message_repr.mli | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/proto_alpha/lib_protocol/sc_rollup_PVM_sem.mli b/src/proto_alpha/lib_protocol/sc_rollup_PVM_sem.mli index 30089681791a..840dd31ecb4c 100644 --- a/src/proto_alpha/lib_protocol/sc_rollup_PVM_sem.mli +++ b/src/proto_alpha/lib_protocol/sc_rollup_PVM_sem.mli @@ -48,7 +48,7 @@ a given [inbox_level] and contains a given [payload]. According the rollup management protocol, the payload must be obtained - through {!Sc_rollup_inbox_message_repr.to_bytes} which follows a documented + through {!Sc_rollup_inbox_message_repr.serialize} which follows a documented format. *) type input = { inbox_level : Raw_level_repr.t; diff --git a/src/proto_alpha/lib_protocol/sc_rollup_inbox_message_repr.mli b/src/proto_alpha/lib_protocol/sc_rollup_inbox_message_repr.mli index 7611afd6220a..10c4208a1c56 100644 --- a/src/proto_alpha/lib_protocol/sc_rollup_inbox_message_repr.mli +++ b/src/proto_alpha/lib_protocol/sc_rollup_inbox_message_repr.mli @@ -25,7 +25,7 @@ (** This module exposes a type {!t} that represents inbox messages. Inbox messages are produced by the Layer 1 protocol and are encoded using the - {!to_bytes} function, before being added to a smart-contract rollup's inbox. + {!serialize} function, before being added to a smart-contract rollup's inbox. They are part of the [Rollup Management Protocol] that defines the communication protocol for exchanging messages between Layer 1 and Layer 2 -- GitLab From ceded48f041809590e6aa6be06a73eb21512b4f1 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Thu, 7 Jul 2022 13:56:11 +0200 Subject: [PATCH 5/5] doc: fix protocol section name generated by snapshot_alpha.sh --- docs/index.rst | 2 +- scripts/snapshot_alpha.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 690e3d47b7e9..d306ffc25c48 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -158,7 +158,7 @@ in the :ref:`introduction `. .. toctree:: :maxdepth: 2 - :caption: kathmandu Kathmandu Protocol doc: + :caption: Kathmandu Protocol doc: kathmandu/protocol kathmandu/glossary diff --git a/scripts/snapshot_alpha.sh b/scripts/snapshot_alpha.sh index af02a6a854d7..46df46d39902 100755 --- a/scripts/snapshot_alpha.sh +++ b/scripts/snapshot_alpha.sh @@ -120,7 +120,7 @@ doc_index="docs/index.rst" grep -A9999 -F "$alpha_line" "$doc_index" \ | grep -B9999 -F 'toctree' -m1 \ | head -n-1 \ - | sed -e "s/Alpha Development/${label} ${capitalized_label}/g" \ + | sed -e "s/Alpha Development/${capitalized_label}/g" \ -e "s,alpha/,${label}/,g" grep -B9999 -F "$alpha_line" "$doc_index" \ | tac \ -- GitLab