Move key-binding descriptions from class docstring to pypeit_show_1dspec description#2089
Move key-binding descriptions from class docstring to pypeit_show_1dspec description#2089kbwestfall wants to merge 3 commits intopypeit:releasefrom
pypeit_show_1dspec description#2089Conversation
|
@ejeschke Somewhat related to this, the If it can't connect to an already open ginga window. Should this instead be: ? |
|
|
||
| This is a short-cut of sorts to pull the object you want without | ||
| typing in its name. | ||
| Enter the mode |
There was a problem hiding this comment.
Thank you for this @kbwestfall!
One thing that I keep forgetting when I use pypeit_show_1dspec is how to show the help screen on the side with all the relevant bindings.
Do you mind adding here that, after entering the mode, by typing h in the plot window ginga will show the help on the side?
| @@ -107,7 +122,7 @@ def main(cls, args): | |||
| if args.obj is not None: | |||
There was a problem hiding this comment.
Should this be:
if args.obj is not None:
exten = np.where(sobjs.NAME == args.obj)[0][0]
else:
exten = args.exten-1 # 1-index in FITS file
if exten < 0:
raise PypeItError(f"Bad input extension/object name: {args.obj}")
| See :ref:`pypeit_show_1dspec_interact` for interactivity implemented here. | ||
| """ | ||
|
|
||
| # Needs to be set by reference viewer (via set_shell_ref) before any |
There was a problem hiding this comment.
@kbwestfall , I don't think you should remove this help docstring. It is used by Ginga to show help for that pypeit special mode when a person types 'h'. I suppose we could add a special command to fetch the help from somewhere else, but I would be a little concerned that we bypassed the internal help system.
No, doesn't need to because |
As titled. This is primarily a documentation PR that is directly to
release, and it includes some changelog comments related to #2079.I'll tag and release version 2.0.1, assuming this passes tests.