README.adoc: use the correct `python3-api` section ID

[normand.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index e350be56c02d75b1861b2901577a90202bf560fc..f0435be2f943ed3fc71dc04c0553146631f11bf2 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -29,7 +29,7 @@ _**Normand**_ is a text-to-binary processor with its own language.
 This package offers both a portable {py3} module and a command-line
 tool.
 
-WARNING: This version of Normand is 0.4, meaning both the Normand
+WARNING: This version of Normand is 0.5, meaning both the Normand
 language and the module/CLI interface aren't stable.
 
 ifdef::env-github[]
@@ -253,7 +253,7 @@ to learn more about a user site installation.
 [NOTE]
 ====
 Normand has a single module file, `normand.py`, which you can copy as is
-to your project to use it (both the <<python-3-api,`normand.parse()`>>
+to your project to use it (both the <<python3-api,`normand.parse()`>>
 function and the <<command-line-tool,command-line tool>>).
 
 `normand.py` has _no external dependencies_, but if you're using
@@ -271,7 +271,7 @@ current state:
 
 [%header%autowidth]
 |===
-|State variable |Description |Initial value: <<python-3-api,{py3} API>> |Initial value: <<command-line-tool,CLI>>
+|State variable |Description |Initial value: <<python3-api,{py3} API>> |Initial value: <<command-line-tool,CLI>>
 
 |[[cur-offset]] Current offset
 |
@@ -1053,9 +1053,6 @@ class ByteOrder(enum.Enum):
     LE = ...
 
 
-VarsT = typing.Dict[str, int]
-
-
 class TextLoc:
     # Line number.
     @property
@@ -1075,6 +1072,9 @@ class ParseError(RuntimeError):
         ...
 
 
+SymbolsT = typing.Dict[str, int]
+
+
 class ParseResult:
     # Generated data.
     @property
@@ -1083,12 +1083,12 @@ class ParseResult:
 
     # Updated variable values.
     @property
-    def variables(self) -> VarsT:
+    def variables(self) -> SymbolsT:
         ...
 
     # Updated main group label values.
     @property
-    def labels(self) -> VarsT:
+    def labels(self) -> SymbolsT:
         ...
 
     # Final offset.
@@ -1098,12 +1098,13 @@ class ParseResult:
 
     # Final byte order.
     @property
-    def byte_order(self) -> typing.Optional[int]:
+    def byte_order(self) -> typing.Optional[ByteOrder]:
         ...
 
+
 def parse(normand: str,
-          init_variables: typing.Optional[VarsT] = None,
-          init_labels: typing.Optional[VarsT] = None,
+          init_variables: typing.Optional[SymbolsT] = None,
+          init_labels: typing.Optional[SymbolsT] = None,
           init_offset: int = 0,
           init_byte_order: typing.Optional[ByteOrder] = None) -> ParseResult:
     ...