Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added DRLD description of recipes to documentation in recipe #108

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

JenniferKarr
Copy link
Collaborator

No description provided.

Comment on lines 169 to 171
_description = """
This recipe performs basic reduction (dark current subtraction, flat fielding,\n
optional bias subtraction, persistance and linearity corrections) on engineering\n
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps check what happens with the indentation. That is, how does it look when you ask pyesorex for the description of the recipe (I don't know how to do that).

In case it prints out the indentation, then you can perhaps better remove the indentation; that is, place the text all the way to the left of the file.

_description = """
This recipe performs basic reduction (dark current subtraction, flat fielding,\n
optional bias subtraction, persistance and linearity corrections) on engineering\n
images of the pupil masks. This recipe is not expected to be used by observers\n
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Related, you don't need these \n here, because the triple quotes already take the actual line breaks into account. So printing this string will have double line breaks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, they add extra lines in the man-page print out:

pyesorex --man-page metis_pupil_imaging

I'll remove them and update Jennifiers commit

Removed whitespace
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants