-
Notifications
You must be signed in to change notification settings - Fork 17
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
Rename usage examples #67
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! I didn't go as far as rendering the docs, but I trust that it looks fine.
docs/source/examples.rst
Outdated
examples/admm_tv_deconvolution | ||
examples/admm_tv_circ_deconvolution | ||
examples/pgm_ppp_bm3d_deconvolution | ||
examples/deconv_circ_tv_admm | ||
examples/deconv_microscopy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
deconv_microscopy uses TV and ADMM, so maybe deconv_microscopy_tv_admm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. Done.
FWIW, you don't have to do it manually since the docs are built as part of the automated checks; see the |
Rename example scripts. Also partially addresses #47.
See lanl/scico-data#1, which should be merged just prior to merging this PR.