search

mojidev-py / discmoji

A discord API wrapper made for fun
MIT License
4 stars 1 forks source link

Docstrings are missing #5

Closed XenonPy closed 2 months ago

XenonPy commented 2 months ago

Functions appear to have comments describing what they do...

def do_something(x):
     # this does something
     run code
     more code

However, as specified in PEP 257, these should be formatted as docstrings:

def do_something(x):
     """
     This does something.
     """
     run code
     more code

https://peps.python.org/pep-0257/

mojidev-py commented 2 months ago

most of those commented functions are meant to be internal

mojidev-py commented 2 months ago

since they have an underscore before their name

XenonPy commented 2 months ago

oops 😅

yeah i missed that