From edb0336fd0253e8537b452189180dcd5b4f3cdc5 Mon Sep 17 00:00:00 2001
From: Philipp Wullstein-Kammler <111539239+phiwuu@users.noreply.github.com>
Date: Tue, 22 Oct 2024 10:53:11 +0200
Subject: [PATCH] Add known issue to `lobster-python` readme (#105)

---
 packages/lobster-tool-python/README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/packages/lobster-tool-python/README.md b/packages/lobster-tool-python/README.md
index ebe9acb9..addfd374 100644
--- a/packages/lobster-tool-python/README.md
+++ b/packages/lobster-tool-python/README.md
@@ -66,6 +66,14 @@ Please note that the generated output json files always use `PyTest` as framewor
 }
 ```
 
+## Known Issues
+
+The resulting lobster file does not use the method names, but instead uses the class name together with an integer counter for consecutive methods.
+This only affects methods in a class.
+It does not affect functions.
+For details see see [issue 89](https://github.com/bmw-software-engineering/lobster/issues/89).
+It will be fixed with the next release.
+
 ## Copyright & License information
 
 The copyright holder of LOBSTER is the Bayerische Motoren Werke