-
Notifications
You must be signed in to change notification settings - Fork 74
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 jdaviz developer installation instructions #2569
Conversation
…ython magic commands, and added description to code contribution section
Should we also include advice that it is necessary to install without |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2569 +/- ##
==========================================
- Coverage 90.87% 90.82% -0.05%
==========================================
Files 160 160
Lines 19388 19388
==========================================
- Hits 17618 17609 -9
- Misses 1770 1779 +9 ☔ View full report in Codecov by Sentry. |
Yes that sounds like a good idea to me |
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.
Works for me - thanks!
Rendered docs can be previewed here.
Thanks and congrats on your first PR! |
* In installation.rst, changed the order of dev install steps, added IPython magic commands, and added description to code contribution section * Added a note to install first without -e flag to obtain template files --------- Co-authored-by: Gilbert Green <ggreen@tapangalia2023.local>
Description
In installation.rst, the order of development install instructions have been changed (primarily to move the editable environment to the last step). The addition of IPython magic commands were included as an optional suggestion for developers, and a brief description to code contribution instructions (hyperlink to astropy instructions) was added so a new developer can briefly understand what is hyperlinked; and a general suggestion to virtual environments is now suggested.
Original Instructions
Updated Instructions
Change log entry
CHANGES.rst
? If you want to avoid merge conflicts,list the proposed change log here for review and add to
CHANGES.rst
before merge. If no, maintainershould add a
no-changelog-entry-needed
label.Checklist for package maintainer(s)
This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.
trivial
label.