From 02ba60cfb8db0288977724ebe73a13ee68544c31 Mon Sep 17 00:00:00 2001 From: dencheva Date: Thu, 30 Sep 2010 19:07:47 +0000 Subject: Added documentaion git-svn-id: http://svn.stsci.edu/svn/ssb/stsci_python/stsci_python/trunk/stwcs@10441 fe389314-cf27-0410-b35b-8c050e845b92 --- updatewcs/det2im.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'updatewcs/det2im.py') diff --git a/updatewcs/det2im.py b/updatewcs/det2im.py index c9837c9..993ec52 100644 --- a/updatewcs/det2im.py +++ b/updatewcs/det2im.py @@ -7,12 +7,16 @@ import utils class DET2IMCorr(object): def updateWCS(cls, fobj): """ - :Parameters: - `fobj`: pyfits object - Science file, for which a detector to image correction - is available - Uses a kw 'D2IMFILE' in the primary header to create an extension with - a detector to image correction. + Parameters + ---------- + fobj: pyfits object + Science file, for which a detector to image correction + is available + + Notes + ----- + Uses the file pointed to in the primary header keyword 'D2IMFILE' + to create an extension with a detector to image correction. """ assert isinstance(fobj, pyfits.HDUList) -- cgit