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

update docs for lacosmic sepmed parameter [docs only] #702

Merged
merged 3 commits into from Dec 9, 2019

Conversation

jradavenport
Copy link
Contributor

@jradavenport jradavenport commented Sep 26, 2019

Please have a look at the following list and replace the "[ ]" with a "[x]" if
the answer to this question is yes.

  • For new contributors: Did you add yourself to the "Authors.rst" file?

For documentation changes:

  • For documentation changes: Does your commit message include a "[skip ci]"?
    Note that it should not if you changed any examples!

    My commit message used: [docs only], which I assume also behaves like [skip ci]

For bugfixes:

  • Did you add an entry to the "Changes.rst" file?
  • Did you add a regression test?
  • Does the commit message include a "Fixes #issue_number" (replace "issue_number").
  • Does this PR add, rename, move or remove any existing functions or parameters?

For new functionality:

  • Did you add an entry to the "Changes.rst" file?
  • Did you include a meaningful docstring with Parameters, Returns and Examples?
  • Does the commit message include a "Fixes #issue_number" (replace "issue_number").
  • Did you include tests for the new functionality?
  • Does this PR add, rename, move or remove any existing functions or parameters?

Please note that the last point is not a requirement. It is meant as a check if
the pull request potentially breaks backwards-compatibility.


Fixes #631 by clarifying the sepmed parameter is for performance only, and not part of the L.A. Cosmic algorithm natively.

Also corrected typo of "lacosmic" to "L.A. Cosmic", per the original paper.

CHANGES.rst Outdated
@@ -18,6 +18,7 @@ New Features

Other Changes and Additions
^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Clarified ``sepmed`` default in ``cosmicray_lacosmic`` docs. [#702]
Copy link
Member

Choose a reason for hiding this comment

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

no need for changelog for docs only changes.

@bsipocz bsipocz added the docs label Sep 26, 2019
@bsipocz bsipocz added this to the 2.0.2 milestone Sep 26, 2019
@bsipocz
Copy link
Member

bsipocz commented Sep 26, 2019

Welcome @jradavenport!

@bsipocz
Copy link
Member

bsipocz commented Sep 26, 2019

My commit message used: [docs only], which I assume also behaves like [skip ci]

Indeed, it's similar. It's a "home grown" option that only works with travis, so here it works as intended.

@MSeifert04
Copy link
Contributor

@jradavenport Thank you for the PR 👍

Could you remove the changelog entry - Then I think this can be merged.

@mwcraig
Copy link
Member

mwcraig commented Dec 9, 2019

Thanks @jradavenpor, merging!

@mwcraig mwcraig merged commit 070360a into astropy:master Dec 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cosmicray_lacosmic sepmed defaults to True
4 participants