From 03bf062fe19ee0be0f6d65cc4d533a97909cc21e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Markus=20Wessl=C3=A9n?= <mw2013@tobii.com>
Date: Wed, 17 Aug 2022 16:43:13 +0200
Subject: [PATCH] Remove excessive template

---
 CONTRIBUTING.md | 64 ++++---------------------------------------------
 README.md       |  2 +-
 2 files changed, 6 insertions(+), 60 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a6fedc6..ff51497 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -31,28 +31,12 @@ More in-depth information of the module. This docstring is placed at the top of
 """
 import asyncio
 
-def my_simple_function(arg_1: str, arg_2: int):
-    """Summary of my_simple_function.
+def my_function(arg_1: str, arg_2: int) -> int:
+    """Summary of my_function.
 
     Takes in a name and number.
 
     Returns a pair of glasses.
-
-    """
-    pass
-
-def my_long_function(arg_1: str, arg_2: int):
-    """Summary of my_simple_function.
-
-    ###### Args
-    - `arg_1`: The first argument.
-    - `arg_2`: The second argument.
-
-    ###### Returns
-    Something you want to use.
-
-    ###### Raises
-    - `MyError`: An error indicating some error.
     """
     pass
 
@@ -69,54 +53,16 @@ class MyClass:
     variable_2: int
     """The second variable"""
 
-    def __init__(arg_1: str):
+    def __init__(arg_1: str) -> None:
         """Initializes object, where arg_1 is your `variable_1`."""
         self.variable_1 = arg_1
 
-    def my_simple_method(arg_1: str, arg_2: int):
+    def my_method(arg_1: str, arg_2: int) -> int:
         """Summary of my_simple_method.
 
         Takes in a name and number.
 
-        Returns something simple.
-        """
-        pass
-
-    def my_long_method(arg_1: str, arg_2: int):
-        """
-        Summary of my_long_method.
-
-        Some more in-depth information about my_long_method.
-
-        ###### Args
-        - `arg_1`: The first argument.
-        - `arg_2`: The second argument.
-
-        ###### Returns
-        Something you want to use.
-
-        ###### Raises
-        - `MyError`: An error indicating some error.
+        Returns something nice.
         """
         pass
-
-class MyAdvancedClass:
-    """Summary of MyAdvancedClass, max 80 characters long.
-
-    Some more in-depth information about MyClass.
-    """
-
-    def __init__(arg_1: str, arg_2: int):
-        """Initializes object.
-
-        ###### Args
-        - `arg_1`: The first argument.
-        - `arg_2`: The second argument.
-
-        ###### Raises
-        - `MyError`: An error indicating some error.
-
-        """
-        pass
-
 ```
diff --git a/README.md b/README.md
index 760391f..7b68561 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # g3pylib
 
-**This library is still in alpha. It's not yet feature complete.**
+**This library is still in alpha. It's not yet feature complete and there are no guarantees that the API will be stable.**
 
 A Python client for Glasses3. It handles all the low level details of communication with the Glasses3 websocket API and exposes a Python API which includes all the endpoints in the websocket API of the Glasses3 as well as some extra convenience methods. It also implements streaming with RTSP and service discovery with Zeroconf.