Documentation additions for 1.3

[mperrin]

Placeholder PR for improvements and additions to the readthedocs for 1.3.

1. add show_wfs_around_obs and show_wfs_during_program to the online docs
2. [more tbd?]

Plus some minor incidentals:

• also some minor tweaks to show_wfs_during_program to improve output plot formatting (in particular, apply clip_on to text dates, so if the user sets start or end dates, labels outside that time range are not shown)

[pep8speaks]

Hello @mperrin, Thank you for updating !

• In the file webbpsf/trending.py:

Line 93:9: E265 block comment should start with '# '
Line 95:9: E265 block comment should start with '# '
Line 96:9: E265 block comment should start with '# '
Line 102:9: E265 block comment should start with '# '
Line 301:25: E712 comparison to False should be 'if cond is False:' or 'if not cond:'
Line 303:27: E712 comparison to True should be 'if cond is True:' or 'if cond:'
Line 384:35: E203 whitespace before ':'
Line 463:1: E266 too many leading '#' for block comment
Line 700:5: E266 too many leading '#' for block comment
Line 715:5: E266 too many leading '#' for block comment
Line 762:5: E266 too many leading '#' for block comment
Line 785:5: E266 too many leading '#' for block comment
Line 945:5: E266 too many leading '#' for block comment
Line 1032:49: W605 invalid escape sequence '\D'
Line 1068:1: E266 too many leading '#' for block comment
Line 1097:43: E203 whitespace before ':'
Line 1187:5: E722 do not use bare 'except'
Line 1340:5: E266 too many leading '#' for block comment
Line 1364:5: E266 too many leading '#' for block comment
Line 1384:22: W605 invalid escape sequence '\D'
Line 1703:126: E501 line too long (146 > 125 characters)
Line 1733:5: E731 do not assign a lambda expression, use a def
Line 2021:25: W605 invalid escape sequence '\D'
Line 2029:1: E266 too many leading '#' for block comment
Line 2108:9: E266 too many leading '#' for block comment
Line 2134:126: E501 line too long (142 > 125 characters)
Line 2145:13: E266 too many leading '#' for block comment
Line 2178:9: E266 too many leading '#' for block comment

Comment last updated at 2024-05-20 22:04:09 UTC

[obi-wan76]

Hi @mperrin I am trying to add a notebook to this PR but it seems that I don't have permission. Can you allow me to add to this PR? Thanks!

[obi-wan76]

I just added a new notebook with a PSF subtraction example. at the end of the notebook there is the usage for the new function nrc_ta_image_comparison

[obi-wan76]

I re-added a notebook with a PSF subtraction example and the nrc_ta_image_comparison. I think that during the force-pushed my notebook got lost, so that's why added it again. In any case, @mperrin your notebooks look good to me. Can you take a look at the PSF subtraction notebook and see if it make senses, the idea is to show at least one way to do a PSF subtraction with some know tools.

[obi-wan76]

@mperrin you mentioned that you add some text/comments into the PSF subtraction notebook, is this correct? I don't see a new version of the notebook. Maybe you can upload the version that worked for you, I know there were a couple of old lines not working.

[mperrin]

Yes will do, thanks for the reminder to push those.

[obi-wan76]

@mperrin thanks, this looks really good. Do you have any other document that you think you would like to add to this PR? Or should we go ahead and review/merge so we can move forward with the release?

[mperrin]

There's a couple bits of editing I still want to do, to address the feedback in #738 about that part of the docs being unclear. I'll try to do that right now

[mperrin]

@obi-wan76 OK, I've pushed all the doc updates I plan to do at this time

[obi-wan76]

This looks good, thanks!