Repository: sunpy/sunpy

Issue:
Add clarifications to examples that use `os.environ["JSOC_EMAIL"]`
We have three examples that have `jsoc_email = os.environ["JSOC_EMAIL"]` (where the environment variable is defined in our `conf.py` for Sphinx).  We tell users that they should use their own (registered) email address instead, but we're not clear about how the line should actually be changed.  One user on Element replaced only `"JSOC_EMAIL"` instead of replacing `os.environ["JSOC_EMAIL"]`.  Assuming that we continue to use this (exposed) environment-variable approach, we should be more clear in the associated description.

The three examples are:
https://github.com/sunpy/sunpy/blob/42087228ff25d7e3fcd4d9c86c8af12c311d5b7d/examples/acquiring_data/downloading_cutouts.py#L38-L44
https://github.com/sunpy/sunpy/blob/42087228ff25d7e3fcd4d9c86c8af12c311d5b7d/examples/acquiring_data/fido_metadata_queries.py#L24-L26
https://github.com/sunpy/sunpy/blob/42087228ff25d7e3fcd4d9c86c8af12c311d5b7d/examples/acquiring_data/querying_and_loading_SHARP_data.py#L23-L26


Discussion:
@ayshih  can you assign me this issue?
Hello @abastola0, we do not assign people to issues as a general rule.
alright. I'll send a pr directly then. 

Resolving patch:
diff --git a/examples/acquiring_data/downloading_cutouts.py b/examples/acquiring_data/downloading_cutouts.py
--- a/examples/acquiring_data/downloading_cutouts.py
+++ b/examples/acquiring_data/downloading_cutouts.py
@@ -35,11 +35,10 @@
 cutout = a.jsoc.Cutout(bottom_left, top_right=top_right, tracking=True)
 
 #####################################################
-# Exporting data from the JSOC requires registering your
-# email first. Please replace this with your email
-# address once you have registered.
-# See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`_
-# for more details.
+# Exporting data from the JSOC requires registering your email first.
+# Please replace this with your email address once you have registered
+# like so: jsoc_email = "your_email@example.com"
+# See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`__ for more details.
 
 jsoc_email = os.environ["JSOC_EMAIL"]
 
diff --git a/examples/acquiring_data/fido_metadata_queries.py b/examples/acquiring_data/fido_metadata_queries.py
--- a/examples/acquiring_data/fido_metadata_queries.py
+++ b/examples/acquiring_data/fido_metadata_queries.py
@@ -21,8 +21,11 @@
 
 timerange = a.Time('2010/8/1 03:40', '2010/8/1 3:40:10')
 
-# Note that JSOC needs an email address to export the files, if you want to run
-# this, you must supply your own email here.
+# Exporting data from the JSOC requires registering your email first.
+# Please replace this with your email address once you have registered
+# like so: jsoc_email = "your_email@example.com"
+# See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`__ for more details.
+
 jsoc_email = os.environ["JSOC_EMAIL"]
 
 results = Fido.search(timerange,
diff --git a/examples/acquiring_data/querying_and_loading_SHARP_data.py b/examples/acquiring_data/querying_and_loading_SHARP_data.py
--- a/examples/acquiring_data/querying_and_loading_SHARP_data.py
+++ b/examples/acquiring_data/querying_and_loading_SHARP_data.py
@@ -21,8 +21,10 @@
 # and make use of the search attributes in `sunpy.net.jsoc` that allow us to query the JSOC.
 #
 # Exporting data from the JSOC requires registering your email first.
-# Please replace this with your email address once you have registered.
+# Please replace this with your email address once you have registered
+# like so: jsoc_email = "your_email@example.com"
 # See `this page <http://jsoc.stanford.edu/ajax/register_email.html>`__ for more details.
+
 jsoc_email = os.environ["JSOC_EMAIL"]
 
 result = Fido.search(a.Time("2011-03-09 23:20:00", "2011-03-09 23:30:00"),


Test patch: