Fix first line of docstrings

- Use the imperative sense
- Use trailing dot
- Omit leading newline
- Grammar / vocabulary fixes
This commit is contained in:
Mads Marquart
2019-07-21 23:46:09 +02:00
parent 700cf14a50
commit 6b07f1d8b9
14 changed files with 226 additions and 335 deletions

View File

@@ -6,7 +6,10 @@ from ._core import Enum
class ThreadType(Enum):
"""Used to specify what type of Facebook thread is being used. See :ref:`intro_threads` for more info"""
"""Used to specify what type of Facebook thread is being used.
See :ref:`intro_threads` for more info.
"""
USER = 1
GROUP = 2
@@ -24,7 +27,7 @@ class ThreadLocation(Enum):
class ThreadColor(Enum):
"""Used to specify a thread colors"""
"""Used to specify a thread colors."""
MESSENGER_BLUE = "#0084ff"
VIKING = "#44bec7"
@@ -60,7 +63,7 @@ class ThreadColor(Enum):
@attr.s(cmp=False, init=False)
class Thread(object):
"""Represents a Facebook thread"""
"""Represents a Facebook thread."""
#: The unique identifier of the thread. Can be used a ``thread_id``. See :ref:`intro_threads` for more info
uid = attr.ib(converter=str)