Skip to content
This repository has been archived by the owner on Nov 20, 2024. It is now read-only.

Commit

Permalink
Remove excessive template
Browse files Browse the repository at this point in the history
  • Loading branch information
m4reko committed Aug 17, 2022
1 parent b9f4df9 commit 03bf062
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 60 deletions.
64 changes: 5 additions & 59 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 03bf062

Please sign in to comment.