From c5acf9dc271289915ec7917c7110201b8c59c84e Mon Sep 17 00:00:00 2001 From: Roberto Rosmaninho Date: Fri, 19 Jul 2024 13:02:39 -0300 Subject: [PATCH] Removing example of relative position as Napoleon can't render it properly (#4535) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix: https://github.com/Pi-Squared-Inc/pi2/issues/1644 Unfortunately, Napoleon extensions can't escape `:` and treat everything before it as a type thus, the rendering of this example was outputting a wrong and malformed description of the function as shown below: ![Captura de Tela 2024-07-19 às 10 01 18](https://github.com/user-attachments/assets/2091230d-dd0f-4575-9308-515ffbf12041) As this isn't a key feature description, we chose to remove it to get cleaner documentation: ![Captura de Tela 2024-07-19 às 10 04 41](https://github.com/user-attachments/assets/d203151b-38d9-45db-8e57-3993e8b7d1ee) This is a known issue discussed here: https://github.com/sphinx-doc/sphinx/issues/9273 --- pyk/src/pyk/kllvm/hints/prooftrace.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyk/src/pyk/kllvm/hints/prooftrace.py b/pyk/src/pyk/kllvm/hints/prooftrace.py index 29a2cb4bfef..2cc98e6f0ed 100644 --- a/pyk/src/pyk/kllvm/hints/prooftrace.py +++ b/pyk/src/pyk/kllvm/hints/prooftrace.py @@ -201,7 +201,7 @@ def name(self) -> str: @property def relative_position(self) -> str: - """Return the relative position of the LLVM function event in the proof trace. Ex.: (0:0:0:0).""" + """Return the relative position of the LLVM function event in the proof trace.""" return self._function_event.relative_position @property @@ -243,7 +243,7 @@ def name(self) -> str: @property def relative_position(self) -> str: - """Return the relative position of the hook event in the proof trace. Ex.: (0:0:0:0).""" + """Return the relative position of the hook event in the proof trace.""" return self._hook_event.relative_position @property