iraf-community / iraf-fitsutil

FITS utilities
https://iraf.readthedocs.io/en/latest/tasks/fitsutil
Other
1 stars 1 forks source link

Fix documentation of examples #19

Closed olebole closed 2 weeks ago

olebole commented 2 weeks ago

The examples were often lazily formatted, with either completely being in a .nf/.fi (preformatted/code) section or completely outside, like for fgwrite:

2) Create an archive of the current directory and its subdirectories excluding any symbolic links. cl> fgwrite . ../zzd_arc.fits exclude=s checksum=yes The ckecksum option is set, so the keyword CHECKSUM, DATASUM and CHECKVER will be present in all unit headers.

This PR corrects this:

  1. Create an archive of the current directory and its subdirectories excluding any symbolic links.

    cl> fgwrite . ../zzd_arc.fits exclude=s checksum=yes 

    The ckecksum option is set, so the keyword CHECKSUM, DATASUM and CHECKVER will be present in all unit headers.