]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-119786: move locations doc to InternalDocs (#120445)
authorIrit Katriel <1055913+iritkatriel@users.noreply.github.com>
Wed, 19 Jun 2024 16:58:54 +0000 (17:58 +0100)
committerGitHub <noreply@github.com>
Wed, 19 Jun 2024 16:58:54 +0000 (17:58 +0100)
InternalDocs/README.md
InternalDocs/locations.md [moved from Objects/locations.md with 88% similarity]

index 42f6125794266af04600b39f365381d7b0c273b2..2918ead265dcd11af733c3fe9b61e980fc140737 100644 (file)
@@ -14,6 +14,8 @@ it is not, please report that through the
 
 [Compiler Design](compiler.md)
 
-[Exception Handling](exception_handling.md)
-
 [Adaptive Instruction Families](adaptive.md)
+
+[The Source Code Locations Table](locations.md)
+
+[Exception Handling](exception_handling.md)
similarity index 88%
rename from Objects/locations.md
rename to InternalDocs/locations.md
index 18a338a95978a9d1d1c355e5ed6093f57bdc6ddf..91a7824e2a8e4d896a87e71d34d18d7ce08b74df 100644 (file)
@@ -1,10 +1,10 @@
 # Locations table
 
-For versions up to 3.10 see ./lnotab_notes.txt
+The `co_linetable` bytes object of code objects contains a compact
+representation of the source code positions of instructions, which are
+returned by the `co_positions()` iterator.
 
-In version 3.11 the `co_linetable` bytes object of code objects contains a compact representation of the positions returned by the `co_positions()` iterator.
-
-The `co_linetable` consists of a sequence of location entries.
+`co_linetable` consists of a sequence of location entries.
 Each entry starts with a byte with the most significant bit set, followed by zero or more bytes with most significant bit unset.
 
 Each entry contains the following information: