From 9011189f4969aa74150abe493bf4b22886f7c372 Mon Sep 17 00:00:00 2001
From: dencheva <dencheva@stsci.edu>
Date: Thu, 30 Sep 2010 19:07:33 +0000
Subject: Added documentaion

git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@10440 fe389314-cf27-0410-b35b-8c050e845b92
---
 wcsutil/altwcs.py | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

(limited to 'wcsutil/altwcs.py')

diff --git a/wcsutil/altwcs.py b/wcsutil/altwcs.py
index 4cfb033..42a2d67 100644
--- a/wcsutil/altwcs.py
+++ b/wcsutil/altwcs.py
@@ -290,9 +290,11 @@ def wcskeys(header):
 
 def wcsnames(header):
     """
-    Purpose
-    =======
-    Return a dictionary of wcskey: WCSNAME pairs
+    Returns a dictionary of wcskey: WCSNAME pairs
+    
+    Parameters
+    ----------
+    header: pyfits.Header
     """
     names = header["WCSNAME*"]
     d = {}
@@ -340,6 +342,12 @@ def getKeyFromName(header, wcsname):
     If WCSNAME is found in header, return its key, else return 
     None. This is used to update an alternate WCS
     repeatedly and not generate new keys every time.
+    
+    Parameters
+    ----------
+    header:  pyfits.Header
+    wcsname: str
+             Value of WCSNAME
     """
     wkey = None
     names = wcsnames(header)
-- 
cgit