Update/fix documentation

David Marteau · David Marteau · commit ed0b6643a6d8 · 2014-11-24T18:17:21.000+01:00
diff --git a/pylr/binary.py b/pylr/binary.py
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
-'''
-Created on 4 déc. 2013
-
-@author: Mappy S.A.
+''' Support definition and intermediate parsing of binary encoded locations
 '''
 
 from collections import namedtuple
diff --git a/pylr/constants.py b/pylr/constants.py
@@ -1,10 +1,7 @@
 # -*- coding: utf-8 -*-
+''' Constante definitions
 '''
-Created on 4 déc. 2013
 
-@author: Mappy S.A.
-
-'''
 
 from .utils import enum
 
diff --git a/pylr/decoder.py b/pylr/decoder.py
@@ -1,8 +1,9 @@
 # -*- coding: utf-8 -*-
-'''
-Created on 2 janv. 2014
+''' OpenLR decoder and database interfaces
 
-@author: Mappy S.A.
+    Pylr use an abstract mapdatabase interface for accessing grapth data.
+    The map database is passed to the decoder for calculating route and shortest path between 
+    location reference points.
 '''
 from __future__ import print_function
 
@@ -138,12 +139,15 @@ class RouteConstructionFailed(RouteSearchException):
 
 
 class MapDatabase(object):
-
+    """ The map database is an abstract interface used by the decoder object.
+        Implementor of database should inherit from this abstract class.
+    """
+    
     """ Node interface
         distance: the distance from the search location
     """
     Node = namedtuple('Node', ('distance',))
-
+ 
     """ Line interface
         distance: the distance from the search location
         
@@ -196,7 +200,7 @@ def find_closeby_lines(self, coords, max_node_dist, frc_max, beardir):
         raise NotImplementedError("MapDatabase:find_closeby_lines")
 
     def calculate_route(self, l1, l2, maxdist, lfrc, islastrp):
-        """ Calculate the shortest path between two lines
+        """ Calculate the shortest paths between two lines
         
             :param l1: the first candidate line to begin the search from
             :param l2: the second candidate line to stop the search to
diff --git a/pylr/fow.py b/pylr/fow.py
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
-'''
-Created on 5 déc. 2013
-
-@author: Mappy S.A
+''' Fow constants
 '''
 
 UNDEFINED = 0
diff --git a/pylr/parser.py b/pylr/parser.py
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
-'''
-Created on 4 déc. 2013
-
-@author: Mappy S.A.
+''' Location parser 
 '''
 
 from collections import namedtuple
diff --git a/pylr/rating.py b/pylr/rating.py
@@ -1,9 +1,7 @@
 # -*- coding: utf-8 -*-
+''' Handle Form Of Way (fow) rating
 '''
-Created on 2 janv. 2014
 
-@author: Mappy S.A.
-'''
 
 import fow
 
diff --git a/pylr/tests/units/test_decoder.py b/pylr/tests/units/test_decoder.py
@@ -19,7 +19,9 @@
                       DecoderError,
                       MapDatabase,
                       AGAINST_LINE_DIRECTION,
-                      WITH_LINE_DIRECTION, )
+                      WITH_LINE_DIRECTION,
+                      fow )
+    from pylr.rating import get_fow_rating_category
     import pyproj
 except:
     import traceback
@@ -170,3 +172,19 @@ def test_21_find_candidate_lines(self):
         lines = self.decoder.find_candidate_lines(lrp)
         self.assertGreaterEqual(len(lines), 1)
         self.assertEquals(lines[0][0].id, 'Line1', lines)
+        
+    def test_fow_rating(self):
+        """ OpenLR decoder: test fow rating symmetry """
+        fows = [fow.UNDEFINED,
+                fow.MOTORWAY,
+                fow.MULTIPLE_CARRIAGEWAY,
+                fow.SINGLE_CARRIAGEWAY,
+                fow.ROUNDABOUT,
+                fow.TRAFFICSQUARE,
+                fow.SLIPROAD,
+                fow.OTHER]
+
+        for fow1 in fows:
+            for fow2 in fows:
+                self.assertEquals(get_fow_rating_category(fow1,fow2),
+                                  get_fow_rating_category(fow2,fow1))
diff --git a/pylr/utils.py b/pylr/utils.py
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
-'''
-Created on 4 déc. 2013
-
-@author: Mappy S.A
+''' Some utilities
 '''
 
 
diff --git a/pylr/values.py b/pylr/values.py
@@ -1,9 +1,7 @@
 # -*- coding: utf-8 -*-
+''' Define functions for transforming encoded values
 '''
-Created on 5 déc. 2013
 
-@author: Mappy S.A.
-'''
 from .utils import signum
 from .constants import (BIT24FACTOR_REVERSED,
                         DECA_MICRO_DEG_FACTOR,
