ticketfrei/ticketfrei3
8
1
Fork 0
Code Issues 11 Pull requests 2 Projects 1 Releases Wiki Activity

[misc] Improve docstrings

Browse source 
Mostly by removing whitespace before and after the docstring
This commit is contained in:
Martin Rey 2020-10-13 11:38:33 +02:00 committed by Maike
parent 2954f3700b
commit 4146cb89b5
13 changed files with 32 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
kibicara/platformapi.py
View file

@ -24,10 +24,6 @@ class Message:
message = Message('Message sent from platform xyz', xyz_message_id=123) message = Message('Message sent from platform xyz', xyz_message_id=123)
``` ```
Args:
text (str): The message text
**kwargs (object, optional): Other platform-specific data.
Attributes: Attributes:
text (str): The message text text (str): The message text
**kwargs (object, optional): Other platform-specific data. **kwargs (object, optional): Other platform-specific data.
@ -71,9 +67,6 @@ class Censor:
# XXX send message.text to platform xyz # XXX send message.text to platform xyz
``` ```
Args:
hood (Hood): A Hood Model object
Attributes: Attributes:
hood (Hood): A Hood Model object hood (Hood): A Hood Model object
""" """
@ -120,7 +113,7 @@ class Censor:
@classmethod @classmethod
async def destroy_hood(cls, hood): async def destroy_hood(cls, hood):
"""Removes all its database entries. """Remove all of its database entries.
Note: Override this in the derived bot class. Note: Override this in the derived bot class.
""" """
@ -176,10 +169,6 @@ class Spawner:
spawner = Spawner(XYZ, XYZPlatform) spawner = Spawner(XYZ, XYZPlatform)
``` ```
Args:
ORMClass (ORM Model subclass): A Bot Model object
BotClass (Censor subclass): A Bot Class object
Attributes: Attributes:
ORMClass (ORM Model subclass): A Hood Model object ORMClass (ORM Model subclass): A Hood Model object
BotClass (Censor subclass): A Bot Class object BotClass (Censor subclass): A Bot Class object

2
kibicara/platforms/email/webapi.py
View file

@ -55,6 +55,7 @@ class BodySubscriber(BaseModel):
async def get_email(email_id: int, hood=Depends(get_hood)): async def get_email(email_id: int, hood=Depends(get_hood)):
"""Get Email row by hood. """Get Email row by hood.
You can specify an email_id to nail it down, but it works without as well. You can specify an email_id to nail it down, but it works without as well.
:param hood: Hood the Email bot belongs to. :param hood: Hood the Email bot belongs to.
@ -168,6 +169,7 @@ async def email_read(email=Depends(get_email)):
) )
async def email_delete(email=Depends(get_email)): async def email_delete(email=Depends(get_email)):
"""Delete an Email bot. """Delete an Email bot.
Stops and deletes the Email bot. Stops and deletes the Email bot.
:param hood: Hood the Email bot belongs to. :param hood: Hood the Email bot belongs to.