From f7a70475e2960e3d152bef22ab054bcfe7874e55 Mon Sep 17 00:00:00 2001
From: Ben Wheeler <wheeler.benjamin@gmail.com>
Date: Fri, 30 Aug 2019 16:19:27 -0400
Subject: [PATCH] added explanatory join flow comments

---
 src/components/join-flow/country-step.jsx | 1 +
 src/components/join-flow/join-flow.jsx    | 7 ++++++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/components/join-flow/country-step.jsx b/src/components/join-flow/country-step.jsx
index de1cfa8e5..a99f10506 100644
--- a/src/components/join-flow/country-step.jsx
+++ b/src/components/join-flow/country-step.jsx
@@ -95,6 +95,7 @@ class CountryStep extends React.Component {
                                     validate={this.validateSelect}
                                     validationClassName="validation-full-width-input"
                                 />
+                                {/* note that this is a hidden checkbox the user will never see */}
                                 <FormikCheckbox
                                     id="yesno"
                                     label={this.props.intl.formatMessage({id: 'registration.receiveEmails'})}
diff --git a/src/components/join-flow/join-flow.jsx b/src/components/join-flow/join-flow.jsx
index 52ef77a15..632288b74 100644
--- a/src/components/join-flow/join-flow.jsx
+++ b/src/components/join-flow/join-flow.jsx
@@ -59,7 +59,9 @@ class JoinFlow extends React.Component {
                     country: formData.country,
                     subscribe: true,
                     is_robot: formData.yesno
-                    // csrfmiddlewaretoken: 'abc'
+                    // no need to include csrfmiddlewaretoken; will be provided in
+                    // X-CSRFToken header, which scratchr2 looks for in
+                    // scratchr2/middleware/csrf.py line 237.
                 }
                 /* eslint-enable quote-props */
             }, (err, body, res) => {
@@ -75,6 +77,9 @@ class JoinFlow extends React.Component {
                                 return;
                             }
                             if (body[0].errors) {
+                                // body can include zero or more error objects, each
+                                // with its own key and description. Here we assemble
+                                // all of them into a single string, errStr.
                                 const errorKeys = Object.keys(body[0].errors);
                                 errorKeys.forEach(key => {
                                     const val = body[0].errors[key];