Updated minor problems in docstrings

Author: tomasbedrich

pycaching/geo.py

@@ -408,7 +408,7 @@ def __str__(self):
 
 
 class Block(object):
-    """Container for grouped :class:`.UTFGridPoint`s inside a tile"""
+    """Container for grouped :class:`.UTFGridPoint`s inside a tile."""
 
     # this class can have a lot of instances so use __slots__
     __slots__ = "tile", "cache_wp", "cache_name", "_points", "_xlim", "_ylim", "__weakref__"

pycaching/geocaching.py

@@ -345,5 +345,6 @@ def load_trackable(self, tid):
         """Return a :class:`.Trackable` object by its trackable ID.
 
         .. deprecated:: 3.4
-            Use :meth:`.get_trackable` instead."""
+            Use :meth:`.get_trackable` instead.
+        """
         return self.get_trackable(tid)

pycaching/trackable.py

@@ -162,7 +162,6 @@ def load(self):
 
         :raise LoadError: If trackable loading fails (probably because of not existing cache).
         """
-
         # pick url based on what info we have right now
         if hasattr(self, "url"):
             url = self.url

pycaching/util.py

@@ -18,8 +18,7 @@
 
 
 def lazy_loaded(func):
-    """Decorator providing lazy loading. Used by Cache and Trackable."""
-
+    """Decorator providing lazy loading."""
     @functools.wraps(func)
     def wrapper(*args, **kwargs):
         self = args[0]
@@ -37,10 +36,10 @@ def wrapper(*args, **kwargs):
 # copied from:
 # https://wiki.python.org/moin/PythonDecoratorLibrary#Generating_Deprecation_Warnings
 def deprecated(func):
-    """This is a decorator which can be used to mark functions
-    as deprecated. It will result in a warning being emitted
-    when the function is used."""
+    """Decorator to mark fuction as deprecated.
 
+    It will result in a warning being emitted when the function is used.
+    """
     @functools.wraps(func)
     def new_func(*args, **kwargs):
         warnings.warn_explicit(
@@ -93,9 +92,7 @@ def format_date(date, user_date_format):
 
 def get_possible_attributes():
     """Return a dict of all possible attributes parsed from Groundspeak's website."""
-
-    # imports are here not to slow down other parts of program which normally
-    # doesn't use this method
+    # imports are here not to slow down other parts of program which normally doesn't use this method
     from itertools import chain
     import requests
     from bs4 import BeautifulSoup