more doc changes

CHANGELOG.rst

@@ -1,3 +1,17 @@
+Sunpy 0.9.6 (2019-01-28)
+========================
+
+Features
+--------
+
+- `sunpy.map.Map` can now save out rice compressed FITS files. (`#2826 <https://github.com/sunpy/sunpy/pull/2826>`__)
+
+
+Bug Fixes
+---------
+
+- Fixed `sunpy.io.fits.write` to handle the keyword ``COMMENT`` correctly. (`#2880 <https://github.com/sunpy/sunpy/pull/2880>`__)
+
 Sunpy 0.9.5 (2018-11-27)
 ========================
 

CITATION.rst

@@ -1,20 +1,19 @@
+*****************************
 Acknowledging or Citing SunPy
-=============================
+*****************************
 
 If you have used SunPy in your scientific work we would appreciate it if you would acknowledge it.
-The continued growth and development of SunPy is dependent on the community being aware of the use SunPy.
+The continued growth and development of SunPy is dependent on the community being aware of SunPy.
 
 Publications
-------------
+============
 
-Please add the following line to the conclusion or acknowledgements:
+Please add the following line within your methods, conclusion or acknowledgements sections:
 
    *This research has made use of SunPy vX.Y, an open-source and free
-   community-developed solar data analysis package written in Python
-   (citation).*
+   community-developed solar data analysis Python package (citation).*
 
-The citation should be to the `SunPy paper`_/`arXiv(open access)`_ and the
-version number should cite the `Zenodo DOI`_ for the version used in your work.
+The citation should be to the `SunPy paper`_ and the version number should cite the `Zenodo DOI`_ for the version used in your work.
 
 .. code:: bibtex
 
@@ -43,14 +42,13 @@ version number should cite the `Zenodo DOI`_ for the version used in your work.
         }
 
 Posters and talks
------------------
+=================
 
-Please include the `Sunpy logo`_ on the title, conclusion slide, or
-bout page. For websites please link the image to `sunpy.org`_.
+Please include the `Sunpy logo`_ on the title, conclusion slide, or about page.
+For websites please link the image to `sunpy.org`_.
 Other versions of the logo are available in the `sunpy-logo repository`_.
 
 .. _SunPy paper: https://iopscience.iop.org/article/10.1088/1749-4699/8/1/014009
-.. _arXiv(open access): https://arxiv.org/abs/1505.02563
 .. _Sunpy logo: https://sunpy.org/about/#acknowledging
 .. _sunpy.org: https://sunpy.org/
 .. _sunpy-logo repository: https://github.com/sunpy/sunpy-logo/

CODE_OF_CONDUCT.rst

@@ -26,7 +26,7 @@ Members of the community are considerate of their peers -- other developers, use
 We are thoughtful when addressing the efforts of others, keeping in mind that often the labour was completed simply for the good of the community.
 We are attentive in our communications, whether in person or online, and we're tactful when approaching differing views.
 
-We recognise the work made by everyone and ensure the proper acknowledgement/citation of original authors at all times.
+We recognize the work made by everyone and ensure the proper acknowledgement/citation of original authors at all times.
 As authors, we pledge to be explicit about how we want our own work to be cited or acknowledged.
 
 Respectful
@@ -38,16 +38,16 @@ We are respectful of the volunteer and professional efforts within the community
 We are respectful of the processes set forth in the community, and we work within them (paying particular attention to those new to the community).
 
 When we disagree, we are courteous in raising our issues.
-We provide a harassment- and bullying-free environment, regardless of sex, sexual orientation and/or gender identity, disability, physical appearance, body size, race, nationality, ethnicity, and religion.
+We provide a harassment- and bullying-free environment, regardless of sex, sexual orientation, gender identity, disability, physical appearance, body size, race, nationality, ethnicity, and religion.
 In particular, sexual language and imagery, sexist, racist, or otherwise exclusionary jokes are not appropriate.
 We will treat those outside our community with the same respect as people within our community.
 
-Overall, we are good to each other and apply this CoC to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
+Overall, we are good to each other and apply this code of conduct to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
 
 We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct.
 We will take action when members of our community violate this code such as contacting confidential@sunpy.org (all emails sent to this address will be treated with the strictest confidence) or talking privately with the person.
 
-Parts of this code of conduct have been adapted from the `astropy <http://www.astropy.org/about.html>`__ and the `Python Software Fundation <https://www.python.org/psf/codeofconduct/>`__ codes of conduct.
+Parts of this code of conduct have been adapted from the `astropy <http://www.astropy.org/code_of_conduct.html>`__ and the `Python Software Fundation <https://www.python.org/psf/codeofconduct/>`__ codes of conduct.
 
 License
 =======

CONTRIBUTING.rst

@@ -1,10 +1,10 @@
 .. _newcomers:
 
-*********************************************
-Newcomer's Guide (How to Contribute to SunPy)
-*********************************************
+****************
+Newcomers' Guide
+****************
 
-Welcome to the SunPy newcomers guide.
+Welcome to the SunPy newcomers' guide.
 If you have come across this page, you just might be new to SunPy.
 We aim to be a comprehensive Python package that allows solar physicists to deep dive in the vast amount of solar data available.
 
@@ -24,9 +24,7 @@ If you have any questions, comments or just want to say hello, we have online ch
 How to Contribute to SunPy
 ==========================
 
-Since SunPy is the work of many volunteers, we are always looking for more people to contribute however they can and to join our community.
-
-Non-Code
+Not Code
 --------
 
 A common misconception (which applies to any package) is that all we really want is some Python code, in fact, we do not require only code contributions!
@@ -45,13 +43,14 @@ If you do not want to join Github, then another way to report your issue
 is email the SunPy developers list `sunpy-dev@googlegroups.com`_.
 
 When reporting an issue, please try to provide a short description of the issue with a small code sample, this way we can attempt to reproduce the error.
-Also provide any error output generated when you enchoutered the issue, we can use this information to debug the issue.
+Also provide any error output generated when you encountered the issue, we can use this information to debug the issue.
 For a good example of how to do this see issue `#2879`_.
 
 If you are making a feature request, please post as much information as possible regarding the feature you would like to see in SunPy.
 
 We provide GitHub templates for both of these types of issue.
 Each one has several sections that detail the type of information we are seeking.
+Be sure to read over the comments in the GitHub text box.
 
 .. _issue: https://github.com/sunpy/sunpy/issues
 .. _sunpy-dev@googlegroups.com: https://groups.google.com/forum/#!forum/sunpy-dev
@@ -67,13 +66,13 @@ However, documentation for any project is a living document.
 It is never complete and there are always areas that could be expanded upon or could do with proof reading to check if the text is easy to follow and understandable.
 If parts are confusing or difficult to follow, we would love suggestions or improvements!
 
-.. _online documentation: http://docs.sunpy.org/en/latest/index.html
+.. _online documentation: https://docs.sunpy.org/en/latest/index.html
 
 Reviewing a Pull Request
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-We at any one time have a variety of `pull requests_` open and getting reviews is important.
-Generally the more people that can look over a pull request the better and we encourage everyone to do so.
+We at any one time have a variety of `pull requests`_ open and getting reviews is important.
+Generally the more people that can look over a pull request the better it will turn out and we encourage everyone to do so.
 
 .. _pull requests: https://github.com/sunpy/sunpy/pulls
 
@@ -82,7 +81,7 @@ Code
 
 If you would prefer to code instead, we have several repositories you can investigate.
 The main one is the SunPy repository with where all the known `issues`_ with SunPy are detailed.
-Each issue should have a series of labels that provide some information about the effort required to tackle that issue.
+Each issue should have a series of labels that provide information about nature of the issue.
 
 If you are unsure where to start we suggest the `Package Novice label`_.
 These are issues that have been deemed a good way to be eased into SunPy and are achievable with little understanding of the SunPy codebase.
@@ -104,35 +103,33 @@ Python:
 * `irispy <https://github.com/sunpy/irispy>`_
 * `sunkit-image <https://github.com/sunpy/sunkit-image>`_
 
-CSS/HTML/Python:
+CSS/HTML:
 
 * `sunpy-sphinx-theme <https://github.com/sunpy/sunpy-sphinx-theme>`_
 * `sunpy.org <https://github.com/sunpy/sunpy.org>`_
 
 .. _issues: https://github.com/sunpy/sunpy/issues
-.. _Package Novice label: https://github.com/sunpy/sunpy/issues?q=is%3Aissue+is%3Aopen+label%3Apackage-novice
+.. _Package Novice label: https://github.com/sunpy/sunpy/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Package+Novice%22
 .. _Hacktoberfest: https://hacktoberfest.digitalocean.com/
 .. _Hacktoberfest label: https://github.com/sunpy/sunpy/issues?q=is%3Aissue+is%3Aopen+label%3AHacktoberfest
 
-Development environment
-=======================
+
+Setting up a development environment
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The instructions in this following section are based upon three resources:
 
-* `Astropy Dev Workflow http://docs.astropy.org/en/latest/development/workflow/development_workflow.html>`_
+* `Astropy Dev Workflow <http://docs.astropy.org/en/latest/development/workflow/development_workflow.html>`_
 * `Astropy Dev environment <http://docs.astropy.org/en/latest/development/workflow/get_devel_version.html#get-devel>`_
 * `Astropy Pull Request Example <http://docs.astropy.org/en/latest/development/workflow/git_edit_workflow_examples.html#astropy-fix-example>`_
 
-These contain more in-depth details that apply here but replacing ``astropy`` with ``sunpy``.
-**We strongly recommend a read of these links.**
-
-Setting up a work environment
------------------------------
+These contain more in-depth details that apply here but you will need to replace ``astropy`` with ``sunpy``.
+**We strongly recommend that you read these links.**
 
-In order to start coding you will need a local Python environment and we would recommend using `Anaconda_` or `miniconda`_ (shortened to conda from here on).
+In order to start coding you will need a local Python environment and we would recommend using `Anaconda`_ or `miniconda`_ (shortened to conda from here on).
 This method will bypass your operating system Python packages and makes the entire process easier.
 
-The first step is to install the version of conda that corresponds to your operating system (`instructions here`_).
+The first step is to install the version of conda that corresponds to your operating system, `instructions here`_.
 Next we will want to setup the conda environment and we will need to add the `conda-forge_` channel as a prerequisite:
 
 .. code:: bash
@@ -141,7 +138,7 @@ Next we will want to setup the conda environment and we will need to add the `co
     conda create -n sunpy-dev sunpy
     source activate sunpy-dev
 
-This will create a new conda environment called `sunpy-dev` and install the latest version of SunPy from the conda-forge channel.
+This will create a new conda environment called "sunpy-dev" and install the latest version of SunPy from the conda-forge channel.
 The next step is remove the conda version of SunPy and install the development version of SunPy.
 This will require that `git`_ be installed.
 
@@ -153,7 +150,7 @@ This will make submitting changes easier in the long term for you:
     conda remove sunpy
     git clone https://github.com/sunpy/sunpy.git sunpy-git
     cd sunpy-git
-    pip install -e .[all]
+    pip install -e .[all, dev]
 
 Now you have the latest version of SunPy installed and are ready to work on it using your favorite editor!
 Ideally, when you start making changes you want to create a git branch:
@@ -165,9 +162,9 @@ Ideally, when you start making changes you want to create a git branch:
 You can change ``my_fix`` to anything you prefer.
 If you get stuck or want help, just `ask here`_!
 
-.. _Anaconda: https://www.anaconda.com/
-.. _miniconda: https://conda.io/miniconda.html
-.. _instructions here: https://conda.io/docs/user-guide/install/index.html
+.. _Anaconda: https://www.anaconda.com/distribution/
+.. _miniconda: https://conda.io/en/latest/miniconda.html
+.. _instructions here: https://conda.io/projects/conda/en/latest/user-guide/install/index.html#installation
 .. _conda-forge: https://conda-forge.org/
 .. _git: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
 .. _GitHub: https://github.com/
@@ -176,9 +173,9 @@ If you get stuck or want help, just `ask here`_!
 .. _ask here: https://riot.im/app/#/room/#sunpy-general:matrix.org
 
 Astropy helpers
----------------
+^^^^^^^^^^^^^^^
 
-Within SunPy is a folder called `astropy_helpers_` and this is a git submodule.
+Within SunPy is a folder called `astropy_helpers`_ and this is a git submodule.
 It is very common issue that this not setup correctly and gets added to your commits.
 
 So we recommend that you always run this at the start:
@@ -187,12 +184,12 @@ So we recommend that you always run this at the start:
 
     git submodule update --init
 
-This will resolve any differences in the `astropy_helper` folder on your machine.
+This will resolve any differences in the `astropy_helpers`_ folder on your machine.
 
-.. astropy_helpers: https://github.com/astropy/astropy-helpers
+.. _astropy_helpers: https://github.com/astropy/astropy-helpers
 
 Send it back to us
-------------------
+^^^^^^^^^^^^^^^^^^
 
 Once you have some changes you would like to submit, you will need to commit the changes.
 This is a three stage process:
@@ -205,16 +202,16 @@ Where you replace `<message>` with some text of the work you have done.
 We strongly recommend having a good commit message and this `commit guide`_ is worth reading.
 
 Next step is to open a pull request on GitHub.
-If you are new to pull requests here is a `friendly guide`_.
-Go to the `pull requests_` tab on **your fork** and pressing the large green `New pull request` button.
-Now on the right side from the box marked `compare` you can select your branch.
-Do one final check to make sure the code changes look correct and then press the green `Create pull request` button.
+If you are new to pull requests here is a `GitHub guide`_.
+Go to the "pull requests" tab on **your fork** and pressing the large green "New pull request" button.
+Now on the right side from the box marked "compare" you can select your branch.
+Do one final check to make sure the code changes look correct and then press the green "Create pull request" button.
 
 When you open your pull request, we have a GitHub template that will guide you on what to write in the message box.
 Please fill this in and title the pull request.
-Now the final step is to press the green `Create pull request` button.
+Now the final step is to press the green "Create pull request" button.
 
-As soon as you do this, you will be greeted by a message from `sunpy bot` as well as several continuous integration checks.
+As soon as you do this, you will be greeted by a message from the "sunpy bot" as well as several continuous integration checks.
 These are explained in depth on our :ref: `Version Control <version_control>` page.
 But what is important to know is that these run a series of tests to make sure that the changes do not cause any new errors.
 Now we (the SunPy community) can review the code and offer suggestions and once we are happy, we can merge in the pull request.
@@ -232,6 +229,6 @@ Now you can email this patch to either the  `Google Group`_ or `a SunPy contribu
 Just remember, if you have any problems get in touch!
 
 .. _commit guide: https://chris.beams.io/posts/git-commit/
-.. _friendly guide: https://guides.github.com/activities/hello-world/
+.. _GitHub guide: https://guides.github.com/activities/hello-world/
 .. _Google Group: https://groups.google.com/forum/#!forum/sunpy
 .. _a SunPy contributor: stuart@mumford.me.uk