From ca973fa7003fe9f4ea4d2db3fcca7fe9cdecef16 Mon Sep 17 00:00:00 2001 From: lim Date: Thu, 21 Jun 2012 17:46:47 +0000 Subject: lim corrected doc in unique_points and sorted_points git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/branches/sphere@17464 fe389314-cf27-0410-b35b-8c050e845b92 Former-commit-id: 3dc459c25c7775a9fd3d79246c724e11aa6e8cd7 --- lib/polygon.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'lib/polygon.py') diff --git a/lib/polygon.py b/lib/polygon.py index 7be3f8b..8047ab1 100644 --- a/lib/polygon.py +++ b/lib/polygon.py @@ -291,7 +291,8 @@ class SphericalPolygon(object): def _unique_points(self): """ - Remove duplicate `points`. Order is preserved. + Return a copy of `points` with duplicates removed. + Order is preserved. .. note:: Output cannot be used to build a new polygon. @@ -305,10 +306,10 @@ class SphericalPolygon(object): def _sorted_points(self, preserve_order=True, unique=False): """ - Sort `points` such that smallest (*x*, *y*, *z*) - is on top. + Return a copy of `points` sorted such that smallest + (*x*, *y*, *z*) is on top. - .. note:: Output caanot be used to build a new + .. note:: Output cannot be used to build a new polygon. Parameters @@ -316,7 +317,7 @@ class SphericalPolygon(object): preserve_order: bool Preserve original order? If `True`, polygon is rotated around min point. If `False`, all points - are sorted. + are sorted in ascending order. unique : bool Exclude duplicates. -- cgit