Merge pull request #6 from mdapena/core

Updated the README and documentation index examples
mdapena · Dec 17, 2023 · 24d89d7 · 24d89d7
2 parents bcb2065 + 2692ead
commit 24d89d7
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -391,23 +391,23 @@ Hello, AsyncIOEventEmitter!
 ```Python linenums="1"  hl_lines="7 10-12"
 from pyventus import EventLinker, EventEmitter, AsyncIOEventEmitter
 
+
 with EventLinker.on("StringEvent") as linker:
 
     @linker.on_event
     def event_callback() -> str:
         print("Event received!")
         return "Event succeeded!"
 
-
     @linker.on_success
     def success_callback(msg: str) -> None:
         print(msg)
 
-
     @linker.on_failure
     def failure_callback(exc: Exception) -> None:
         print(exc)
 
+
 event_emitter: EventEmitter = AsyncIOEventEmitter()
 event_emitter.emit("StringEvent")
 ```

diff --git a/docs/index.md b/docs/index.md
@@ -473,25 +473,26 @@ Hello, AsyncIOEventEmitter!
 
 === "Success execution"
 
-	```Python linenums="1"  hl_lines="7 10-12"
+	```Python linenums="1"  hl_lines="9 11-13"
 	from pyventus import EventLinker, EventEmitter, AsyncIOEventEmitter
 
+
 	with EventLinker.on("StringEvent") as linker: # (1)!
+
 	    @linker.on_event
 	    def event_callback() -> str:
 	        print("Event received!")
 	        return "Event succeeded!"
 
-
 	    @linker.on_success
 	    def success_callback(msg: str) -> None:
 	        print(msg)
 
-
 	    @linker.on_failure
 	    def failure_callback(exc: Exception) -> None:
 	        print(exc)
 
+
 	event_emitter: EventEmitter = AsyncIOEventEmitter()
 	event_emitter.emit("StringEvent")
 	```
@@ -510,25 +511,26 @@ Hello, AsyncIOEventEmitter!
 
 === "Error execution"
 
-	```Python linenums="1"  hl_lines="6 15-17"
+	```Python linenums="1"  hl_lines="8 15-17"
 	from pyventus import EventLinker, EventEmitter, AsyncIOEventEmitter
 
+
 	with EventLinker.on("StringEvent") as linker: # (1)!
+
 	    @linker.on_event
 	    def event_callback() -> str:
 	        raise ValueError("Something went wrong!")
 	        return "Event succeeded!"
 
-
 	    @linker.on_success
 	    def success_callback(msg: str) -> None:
 	        print(msg)
 
-
 	    @linker.on_failure
 	    def failure_callback(exc: Exception) -> None:
 	        print(exc)
 
+
 	event_emitter: EventEmitter = AsyncIOEventEmitter()
 	event_emitter.emit("StringEvent")
 	```