From 9011189f4969aa74150abe493bf4b22886f7c372 Mon Sep 17 00:00:00 2001 From: dencheva 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/__init__.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'wcsutil/__init__.py') diff --git a/wcsutil/__init__.py b/wcsutil/__init__.py index 2b74a9c..2b7dbcd 100644 --- a/wcsutil/__init__.py +++ b/wcsutil/__init__.py @@ -9,7 +9,9 @@ from hstwcs import HSTWCS __docformat__ = 'restructuredtext' __version__ = '0.8' - +""" +Example go here +""" def help(): print 'How to create an HSTWCS object:\n\n' @@ -27,8 +29,13 @@ def help(): 3. Create an HSTWCS object using a file name and an extension number. \n Example:\n w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2)\n\n + + 4. Create an HSTWCS object from WCS with key 'O'.\n + Example:\n - 4. Create a template HSTWCS object for a DEFAULT object.\n + w = wcsutil.HSTWCS('j9irw4b1q_flt.fits', ext=2, wcskey='O')\n\n + + 5. Create a template HSTWCS object for a DEFAULT object.\n Example:\n w = wcsutil.HSTWCS(instrument='DEFAULT')\n\n """ -- cgit