update docstring formatting

Author: rongxin-liu

compare50/_api.py

@@ -53,7 +53,7 @@ def rank(submissions, archive_submissions, ignored_files, pass_, n=50):
 
 
 def compare(scores, ignored_files, pass_):
-    """
+    r"""
     :param scores: Scored submission pairs to be compared more granularly
     :type scores: [:class:`compare50.Score`]
     :param ignored_files: files containing distro code
@@ -155,7 +155,7 @@ def expand(span_matches, tokens_a, tokens_b):
     :param tokens_b: :param tokens_a: the tokens of the file corresponding to the first \
             element of each ``span_match``
     :type tokens_b: [:class:`compare50.Token`]
-    :returns: A new list of maximially expanded span pairs
+    :returns: A new list of maximally expanded span pairs
     :rtype: [(:class:`compare50.Span`, :class:`compare50.Span`)]
 
     Expand all span matches. This is useful when e.g. two spans in two different files

compare50/_data.py

@@ -62,15 +62,15 @@ class Comparator(metaclass=abc.ABCMeta):
     """
     @abc.abstractmethod
     def score(self, submissions, archive_submissions, ignored_files):
-        """
+        r"""
         Given a list of submissions, a list of archive submissions, and a set of distro
         files, return a list of :class:`compare50.Score`\ s for each submission pair.
         """
         pass
 
     @abc.abstractmethod
     def compare(self, scores, ignored_files):
-        """
+        r"""
         Given a list of scores and a list of distro files, perform an in-depth
         comparison of each submission pair and return a corresponding list of
         :class:`compare50.Comparison`\ s
@@ -261,7 +261,7 @@ def _raw_contents(self):
 
 @attr.s(slots=True)
 class Comparison:
-    """
+    r"""
     :ivar sub_a: the first submission
     :ivar sub_b: the second submission
     :ivar span_matches: a list of pairs of matching :class:`compare50.Span`\ s, wherein \