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

Remove chips from the documentation #683

Merged
merged 5 commits into from Oct 9, 2019
Merged

Conversation

DougBurke
Copy link
Contributor

@DougBurke DougBurke commented Sep 23, 2019

Summary

Remove mention of ChIPS from the documentation (both on read the docs and in the sherpa.astro.ui and sherpa.ui modules), replacing with matplotlib where appropriate.

Details

Remove mention of ChIPS from the documentation. There is no change to the code in this PR (i.e. the chips backend is still present and included in the config files).

  • from the sphinx build
  • from the docstrings
    • from the description of the clearwindow parameter
    • review the examples to see if chips commands are being used
    • the get_data_plot_prefs routine includes chips defaults, these should either be replaced
      with matplotlib values or just removed (the latter is "technically better" but not actually
      useful to the user)

There are also some minor un-related doc fixes that have come along for the ride. They could be pulled out into a separate PR but it didn't seem worth it at this time.

This is ready for review.

I do not think we need to add a section on "removed" functionality
which describes the ChIPS plotting backend here.
There is still a reference to chips in sherpa/ui/utils.py.
The previous values were ChIPS specific, so that have now been updated
to be for the matplotlib backend. Technically this document can be
used with any backend, but there is currently only one.
@DougBurke
Copy link
Contributor Author

The force push (from 4bcf91c to e3e5365) was to remove a comment (that was a note to fix something that was fixed in this commit) and to address a typo in the commit message.

@DougBurke DougBurke changed the title WIP: Remove chips from the documentation Remove chips from the documentation Sep 24, 2019
@wmclaugh wmclaugh added this to the 4.12.0 milestone Sep 26, 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.

None yet

3 participants