Clarify inline comments

8 years ago · 28fc54fde2
parent bb95546a3c
commit 28fc54fde2
5 changed files with 68 additions and 23 deletions
--- a/public/css/main.css
+++ b/public/css/main.css
@ -6,7 +6,13 @@
 * 3. Import vendors (all third-party CSS)
 */
 /**
- * 1. The page base.
+ * Shadow text mixin.
+ */
+/**
+ * Breakpoint mixin and variable for responsive layouts.
+ */
+/**
+ * The page base.
 */
@import url(vendors/normalize.css);
@import url(vendors/flaticon.css);
@ -27,7 +33,7 @@ body {
  align-items: center; }

 /**
- * 1. First section of the main page, containing the logo, login/registration buttons, and a down arrow.
+ * First section of the main page, containing the logo, login/registration buttons, and a down arrow.
 */
 .intro-page {
  background: linear-gradient(#070a15, #252b46);
@ -39,7 +45,7 @@ body {
      min-height: 100vh; } }

 /**
- * 1. Second section of the main page, containing the three descriptive column and flaticons (http://www.flaticon.com/authors/madebyoliver).
+ * Second section of the main page, containing the three descriptive column and flaticons (http://www.flaticon.com/authors/madebyoliver).
 */
 .info-page {
  background: linear-gradient(#F1D4AF, #eee9d9);
@ -56,7 +62,7 @@ body {
  margin: 50px; }

 /**
- * 1. Third section of the main page, containing the link to the Github page.
+ * Third section of the main page, containing the link to the Github page.
 */
 .footer-page {
  flex: 1;
@ -69,7 +75,7 @@ body {
      height: 100%; } }

 /**
- * 1. Login and register pages.
+ * Login and register pages.
 */
 .login-page {
  background: linear-gradient(#070a15, #252b46);
@ -132,10 +138,16 @@ button {
  font-size: 1.5em;
  font-family: "Montserrat"; }

+/**
+ * Main
+ */
 body {
  font-family: 'Karla', sans-serif;
  font-size: 100%; }

+/**
+ * First section of the main page, containing the logo, login/registration buttons, and a down arrow.
+ */
 .intro-page-logo {
  font-family: 'Montserrat', serif;
  font-size: 12em;
@ -161,6 +173,9 @@ body {
 .fa-angle-double-down {
  color: #424769; }

+/**
+ * Second section of the main page, containing the three descriptive column and flaticons (http://www.flaticon.com/authors/madebyoliver).
+ */
 .info-page h1 {
  font-family: 'Rubik';
  color: #dab199;
@ -186,6 +201,9 @@ body {
    [class^="flaticon-"]:after, [class*=" flaticon-"]:after {
      font-size: 5em; } }

+/**
+ * Third section of the main page, containing the link to the Github page.
+ */
 .footer-page a {
  color: black; }

@ -205,6 +223,9 @@ body {
      font-size: 1em;
      margin: 20px; } }

+/**
+ * Login and register pages.
+ */
 .login-page-logo {
  font-family: 'Montserrat', serif;
  font-size: 6em;
--- a/public/css/main.css.map
+++ b/public/css/main.css.map
@ -1,7 +1,7 @@
 {
 "version": 3,
-"mappings": "AAAA;gFACgF;AAEhF;;;;GAIG;ACPH;;GAEG;ADiBK,kCAAuB;AACvB,iCAAsB;AACtB,uFAA+E;ACjBvF,IAAK;EACH,gBAAgB,EAAE,OAAO;;AAG3B,cAAe;EACb,OAAO,EAAE,YAAY;EACrB,OAAO,EAAE,IAAI;EACb,sBAAsB,EAAE,MAAM;EAC9B,cAAc,EAAE,MAAM;;AAGxB,6DAAU;EACR,OAAO,EAAE,IAAI;EACb,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,MAAM;EACvB,WAAW,EAAE,MAAM;;AAGrB;;GAEG;AAEH,WAAY;EAEV,UAAU,EAAE,iCAAiC;EAC7C,MAAM,EAAE,KAAK;EACb,cAAc,EAAE,MAAM;EACtB,sBAAsB,EAAE,MAAM;ECjB9B,0BAAoC;IDYtC,WAAY;MAOT,UAAU,EAAE,KAAK;;AAIpB;;GAEG;AAEH,UAAW;EAET,UAAU,EAAE,iCAAiC;EAC7C,cAAc,EAAE,GAAG;EACnB,sBAAsB,EAAE,GAAG;EAC3B,UAAU,EAAE,IAAI;EChChB,0BAAoC;ID2BtC,UAAW;MAOR,cAAc,EAAE,MAAM;MACtB,sBAAsB,EAAE,MAAM;MAC9B,UAAU,EAAE,IAAI;;AAInB,eAAgB;EACd,MAAM,EAAE,IAAI;;AAGd;;GAEG;AAEF,YAAa;EAEZ,IAAI,EAAE,CAAC;EACP,gBAAgB,EAAE,OAAO;EACzB,cAAc,EAAE,MAAM;EACtB,sBAAsB,EAAE,MAAM;EAC9B,UAAU,EAAE,IAAI;ECtDhB,0BAAoC;IDgDrC,YAAa;MAQX,MAAM,EAAE,IAAI;;AAIf;;GAEG;AAEH,WAAY;EAEV,UAAU,EAAE,iCAAiC;EAC7C,cAAc,EAAE,MAAM;EACtB,sBAAsB,EAAE,MAAM;;AAGhC,gBAAiB;EACf,gBAAgB,EAAE,IAAI;EACtB,UAAU,EAAE,UAAU;EACtB,aAAa,EAAE,GAAG;EAClB,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,iBAAiB;EAChC,YAAY,EAAE,iBAAiB;EAC/B,WAAW,EAAE,CAAC;;AE5FhB,SAAS;EACP,eAAe,EAAE,IAAI;EACrB,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,IAAI;EACb,QAAQ,EAAE,MAAM;;AAElB,YAAY;EACV,KAAK,EAAE,IAAI;;AAEb,cAAc;EACZ,OAAO,EAAE,YAAY;EACrB,OAAO,EAAE,SAAS;EAClB,eAAe,EAAE,IAAI;EACrB,SAAS,EAAE,IAAI;EACf,gBAAgB,EAAE,IAAI;EACtB,MAAM,EAAE,eAAe;EACvB,aAAa,EAAE,GAAG;EAClB,KAAK,EAAE,OAAO;;AAEhB,oBAAoB;EAClB,gBAAgB,EAAE,OAAO;EACzB,eAAe,EAAE,IAAI;;AAEvB,iBAAiB;EACf,OAAO,EAAE,IAAI;;ACxBf,KAAK;EACH,OAAO,EAAE,IAAI;EACb,UAAU,EAAE,UAAU;EACtB,MAAM,EAAE,iBAAiB;EACzB,aAAa,EAAE,GAAG;EAClB,SAAS,EAAE,KAAK;EAChB,WAAW,EAAE,YAAY;;AAE3B,WAAW;EACT,MAAM,EAAE,cAAc;;AAExB,MAAM;EACJ,gBAAgB,EAAE,OAAO;EACzB,MAAM,EAAE,IAAI;EACZ,KAAK,EAAE,KAAK;EACZ,OAAO,EAAE,SAAS;EAClB,eAAe,EAAE,IAAI;EACrB,MAAM,EAAE,OAAO;EACf,SAAS,EAAE,KAAK;EAChB,WAAW,EAAE,YAAY;;AClB3B,IAAK;EACH,WAAW,EAAE,mBAAmB;EAChC,SAAS,EAAC,IAAI;;AAIhB,gBAAiB;EACf,WAAW,EAAE,mBAAmB;EAChC,SAAS,EAAE,IAAI;EACf,cAAc,EAAE,SAAS;EACzB,KAAK,EAAE,OAAO;EHHd,WAAW,EAFC,mrBAAmD;EAQ/D,0BAAoC;IGPtC,gBAAiB;MAOd,SAAS,EAAE,KAAK;MAChB,OAAO,EAAE,IAAI;MHPd,WAAW,EAFC,6cAAmD;;AGcjE,wBAAyB;EACvB,WAAW,EAAE,oBAAoB;EACjC,SAAS,EAAE,GAAG;EACd,cAAc,EAAE,SAAS;EACzB,KAAK,EAAE,IAAI;EHVX,0BAAoC;IGMtC,wBAAyB;MAMtB,SAAS,EAAE,GAAG;MACd,WAAW,EAAE,IAAI;;AAIpB,qBAAsB;EACpB,KAAK,EAAE,OAAO;;AAIhB,aAAc;EACZ,WAAW,EAAE,OAAO;EACpB,KAAK,EAAE,OAAO;EACd,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,GAAG;EACd,cAAc,EAAE,SAAS;EACzB,WAAW,EAAE,GAAG;EH5BhB,0BAAoC;IGsBtC,aAAc;MAQX,WAAW,EAAE,GAAG;;AAGnB,eAAgB;EACd,SAAS,EAAE,GAAG;EACd,WAAW,EAAE,KAAK;EAClB,KAAK,EAAE,OAAO;;AAGhB;uDACwD;EACtD,SAAS,EAAE,IAAI;EACf,KAAK,EAAE,IAAI;EH1CX,0BAAoC;IGuCtC;2DACwD;MAIpD,SAAS,EAAE,GAAG;;AAKlB,cAAe;EACb,KAAK,EAAE,KAAK;;AAGd,oDAAmB;EACjB,WAAW,EAAE,aAAa;EAC1B,KAAK,EAAE,OAAO;EACd,WAAW,EAAE,OAAO;EACpB,cAAc,EAAE,SAAS;;AAG3B,eAAgB;EAEd,SAAS,EAAE,KAAK;;AAGlB,eAAgB;EAEd,SAAS,EAAE,KAAK;EHnEhB,0BAAoC;IGiEtC,eAAgB;MAIZ,SAAS,EAAE,GAAG;MACd,MAAM,EAAE,IAAI;;AAKhB,gBAAiB;EACf,WAAW,EAAE,mBAAmB;EAChC,SAAS,EAAE,GAAG;EACd,cAAc,EAAE,SAAS;EACzB,KAAK,EAAE,OAAO;EHrFd,WAAW,EAFC,uOAAmD",
-"sources": ["main.scss","partials/_base.scss","modules/_modules.scss","partials/_navigation.sass","partials/_forms.sass","partials/_typography.scss"],
+"mappings": "AAAA;gFACgF;AAEhF;;;;GAIG;ACPH;;GAEG;AAcH;;GAEG;AClBH;;GAEG;AFiBK,kCAAuB;AACvB,iCAAsB;AACtB,uFAA+E;AEjBvF,IAAK;EACH,gBAAgB,EAAE,OAAO;;AAG3B,cAAe;EACb,OAAO,EAAE,YAAY;EACrB,OAAO,EAAE,IAAI;EACb,sBAAsB,EAAE,MAAM;EAC9B,cAAc,EAAE,MAAM;;AAGxB,6DAAU;EACR,OAAO,EAAE,IAAI;EACb,OAAO,EAAE,YAAY;EACrB,eAAe,EAAE,MAAM;EACvB,WAAW,EAAE,MAAM;;AAGrB;;GAEG;AAEH,WAAY;EAEV,UAAU,EAAE,iCAAiC;EAC7C,MAAM,EAAE,KAAK;EACb,cAAc,EAAE,MAAM;EACtB,sBAAsB,EAAE,MAAM;EDR9B,0BAAoC;ICGtC,WAAY;MAOT,UAAU,EAAE,KAAK;;AAIpB;;GAEG;AAEH,UAAW;EAET,UAAU,EAAE,iCAAiC;EAC7C,cAAc,EAAE,GAAG;EACnB,sBAAsB,EAAE,GAAG;EAC3B,UAAU,EAAE,IAAI;EDvBhB,0BAAoC;ICkBtC,UAAW;MAOR,cAAc,EAAE,MAAM;MACtB,sBAAsB,EAAE,MAAM;MAC9B,UAAU,EAAE,IAAI;;AAInB,eAAgB;EACd,MAAM,EAAE,IAAI;;AAGd;;GAEG;AAEF,YAAa;EAEZ,IAAI,EAAE,CAAC;EACP,gBAAgB,EAAE,OAAO;EACzB,cAAc,EAAE,MAAM;EACtB,sBAAsB,EAAE,MAAM;EAC9B,UAAU,EAAE,IAAI;ED7ChB,0BAAoC;ICuCrC,YAAa;MAQX,MAAM,EAAE,IAAI;;AAIf;;GAEG;AAEH,WAAY;EAEV,UAAU,EAAE,iCAAiC;EAC7C,cAAc,EAAE,MAAM;EACtB,sBAAsB,EAAE,MAAM;;AAGhC,gBAAiB;EACf,gBAAgB,EAAE,IAAI;EACtB,UAAU,EAAE,UAAU;EACtB,aAAa,EAAE,GAAG;EAClB,UAAU,EAAE,CAAC;EACb,aAAa,EAAE,iBAAiB;EAChC,YAAY,EAAE,iBAAiB;EAC/B,WAAW,EAAE,CAAC;;AC5FhB,SAAS;EACP,eAAe,EAAE,IAAI;EACrB,MAAM,EAAE,CAAC;EACT,OAAO,EAAE,IAAI;EACb,QAAQ,EAAE,MAAM;;AAElB,YAAY;EACV,KAAK,EAAE,IAAI;;AAEb,cAAc;EACZ,OAAO,EAAE,YAAY;EACrB,OAAO,EAAE,SAAS;EAClB,eAAe,EAAE,IAAI;EACrB,SAAS,EAAE,IAAI;EACf,gBAAgB,EAAE,IAAI;EACtB,MAAM,EAAE,eAAe;EACvB,aAAa,EAAE,GAAG;EAClB,KAAK,EAAE,OAAO;;AAEhB,oBAAoB;EAClB,gBAAgB,EAAE,OAAO;EACzB,eAAe,EAAE,IAAI;;AAEvB,iBAAiB;EACf,OAAO,EAAE,IAAI;;ACxBf,KAAK;EACH,OAAO,EAAE,IAAI;EACb,UAAU,EAAE,UAAU;EACtB,MAAM,EAAE,iBAAiB;EACzB,aAAa,EAAE,GAAG;EAClB,SAAS,EAAE,KAAK;EAChB,WAAW,EAAE,YAAY;;AAE3B,WAAW;EACT,MAAM,EAAE,cAAc;;AAExB,MAAM;EACJ,gBAAgB,EAAE,OAAO;EACzB,MAAM,EAAE,IAAI;EACZ,KAAK,EAAE,KAAK;EACZ,OAAO,EAAE,SAAS;EAClB,eAAe,EAAE,IAAI;EACrB,MAAM,EAAE,OAAO;EACf,SAAS,EAAE,KAAK;EAChB,WAAW,EAAE,YAAY;;ACnB3B;;GAEG;AAEF,IAAK;EACJ,WAAW,EAAE,mBAAmB;EAChC,SAAS,EAAE,IAAI;;AAGjB;;GAEG;AAEF,gBAAiB;EAChB,WAAW,EAAE,mBAAmB;EAChC,SAAS,EAAE,IAAI;EACf,cAAc,EAAE,SAAS;EACzB,KAAK,EAAE,OAAO;EJLd,WAAW,EAFC,mrBAAmD;EAa/D,0BAAoC;IIVrC,gBAAiB;MAOf,SAAS,EAAE,KAAK;MAChB,OAAO,EAAE,IAAI;MJTd,WAAW,EAFC,6cAAmD;;AIgBjE,wBAAyB;EACvB,WAAW,EAAE,oBAAoB;EACjC,SAAS,EAAE,GAAG;EACd,cAAc,EAAE,SAAS;EACzB,KAAK,EAAE,IAAI;EJPX,0BAAoC;IIGtC,wBAAyB;MAMtB,SAAS,EAAE,GAAG;MACd,WAAW,EAAE,IAAI;;AAIpB,qBAAsB;EACpB,KAAK,EAAE,OAAO;;AAGhB;;GAEG;AAEF,aAAc;EACb,WAAW,EAAE,OAAO;EACpB,KAAK,EAAE,OAAO;EACd,UAAU,EAAE,MAAM;EAClB,SAAS,EAAE,GAAG;EACd,cAAc,EAAE,SAAS;EACzB,WAAW,EAAE,GAAG;EJ5BhB,0BAAoC;IIsBrC,aAAc;MAQZ,WAAW,EAAE,GAAG;;AAGnB,eAAgB;EACd,SAAS,EAAE,GAAG;EACd,WAAW,EAAE,KAAK;EAClB,KAAK,EAAE,OAAO;;AAGhB;uDACwD;EACtD,SAAS,EAAE,IAAI;EACf,KAAK,EAAE,IAAI;EJ1CX,0BAAoC;IIuCtC;2DACwD;MAIpD,SAAS,EAAE,GAAG;;AAIlB;;GAEG;AAEF,cAAe;EACd,KAAK,EAAE,KAAK;;AAGd,oDAAmB;EACjB,WAAW,EAAE,aAAa;EAC1B,KAAK,EAAE,OAAO;EACd,WAAW,EAAE,OAAO;EACpB,cAAc,EAAE,SAAS;;AAG3B,eAAgB;EAEd,SAAS,EAAE,KAAK;;AAGlB,eAAgB;EAEd,SAAS,EAAE,KAAK;EJtEhB,0BAAoC;IIoEtC,eAAgB;MAIZ,SAAS,EAAE,GAAG;MACd,MAAM,EAAE,IAAI;;AAIhB;;GAEG;AAEF,gBAAiB;EAChB,WAAW,EAAE,mBAAmB;EAChC,SAAS,EAAE,GAAG;EACd,cAAc,EAAE,SAAS;EACzB,KAAK,EAAE,OAAO;EJhGd,WAAW,EAFC,uOAAmD",
+"sources": ["main.scss","modules/_modules.scss","partials/_base.scss","partials/_navigation.sass","partials/_forms.sass","partials/_typography.scss"],
 "names": [],
 "file": "main.css"
 }
--- a/public/css/modules/_modules.scss
+++ b/public/css/modules/_modules.scss
@ -1,3 +1,7 @@
+/**
+ * Shadow text mixin.
+ */
+
@mixin long-shadow-text ($distance, $blur, $color) {
  $shadows: null;
  $color: darken($color, 10);
@ -9,6 +13,11 @@
  text-shadow: $shadows;
 }

+
+/**
+ * Breakpoint mixin and variable for responsive layouts.
+ */
+
 $break-small: 1200px;

@mixin break-small {
--- a/public/css/partials/_base.scss
+++ b/public/css/partials/_base.scss
@ -1,5 +1,5 @@
 /**
- * 1. The page base.
+ * The page base.
 */

 body {
@ -21,7 +21,7 @@ body {
 }

 /**
- * 1. First section of the main page, containing the logo, login/registration buttons, and a down arrow.
+ * First section of the main page, containing the logo, login/registration buttons, and a down arrow.
 */

 .intro-page {
@ -36,7 +36,7 @@ body {
 }

 /**
- * 1. Second section of the main page, containing the three descriptive column and flaticons (http://www.flaticon.com/authors/madebyoliver).
+ * Second section of the main page, containing the three descriptive column and flaticons (http://www.flaticon.com/authors/madebyoliver).
 */

 .info-page {
@ -57,7 +57,7 @@ body {
 }

 /**
- * 1. Third section of the main page, containing the link to the Github page.
+ * Third section of the main page, containing the link to the Github page.
 */

 .footer-page {
@ -73,7 +73,7 @@ body {
 }

 /**
- * 1. Login and register pages.
+ * Login and register pages.
 */

 .login-page {
--- a/public/css/partials/_typography.scss
+++ b/public/css/partials/_typography.scss
@ -1,11 +1,17 @@
-// main
-body {
+/**
+ * Main
+ */
+
+ body {
  font-family: 'Karla', sans-serif;
-  font-size:100%;
+  font-size: 100%;
 }

-// first section with logo and navigation
-.intro-page-logo {
+/**
+ * First section of the main page, containing the logo, login/registration buttons, and a down arrow.
+ */
+
+ .intro-page-logo {
  font-family: 'Montserrat', serif;
  font-size: 12em;
  text-transform: uppercase;
@ -33,8 +39,11 @@ body {
  color: #424769;
 }

-// second section containing information columns
-.info-page h1 {
+/**
+ * Second section of the main page, containing the three descriptive column and flaticons (http://www.flaticon.com/authors/madebyoliver).
+ */
+
+ .info-page h1 {
  font-family: 'Rubik';
  color: #dab199;
  text-align: center;
@ -60,8 +69,11 @@ body {
  }
 }

-// third section containing the footer
-.footer-page a {
+/**
+ * Third section of the main page, containing the link to the Github page.
+ */
+
+ .footer-page a {
  color: black
 }

@ -86,8 +98,11 @@ body {
 }
 }

-// login and register pages. forms make-up can be found in forms.sass.
-.login-page-logo {
+/**
+ * Login and register pages.
+ */
+ 
+ .login-page-logo {
  font-family: 'Montserrat', serif;
  font-size: 6em;
  text-transform: uppercase;