Merge pull request #8668 from cfpb/ans_docs_update

Minor docs code cleanup
cfpb · Dec 3, 2024 · 8304c74 · 8304c74
2 parents 3d278a2 + 247765e
commit 8304c74
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 90 deletions.
diff --git a/docs/ask-cfpb.md b/docs/ask-cfpb.md
@@ -54,14 +54,14 @@ The payload for the Spanish search term "vehiculo" would look like this, but wit
 
 ```json
 {
-  query: "vehiculo",
-  suggestion: null,
-  result_query: "vehiculo",
-  results: [
+  "query": "vehiculo",
+  "suggestion": null,
+  "result_query": "vehiculo",
+  "results": [
     {
-      url: "https://www.consumerfinance.gov/es/obtener-respuestas/como-puedo-averiguar-el-significado-de-los-terminos-de-mi-contrato-de-leasing-es-2047/",
-      text: " Bajo la Ley de Arrendamientos del Consumidor (CLA, por sus siglas en inglés), la persona o compañía de quien usted hace el leasing de un vehículo, conocida como el "arrendador", deberá informar por escrito ciertos costos y plazos si el leasing es de más de cuatro meses y si cumple con otros requisitos. La mayoría de los arrendamientos de vehículos está sujeta a la CLA. Los siguientes materiales le pueden ayudar a entender los términos de su contrato de leasing. En el sitio web Comprenda cómo funciona la financiación de vehículos de la Comisión Federal de Comercio se ofrece la siguiente información en español: Antes de comprar un vehículo o hacer un leasing ¿Debería hacer un leasing para un vehículo? Glosario de términos específicos Más información en español de GobiernoUSA.gov: Consejos para comprar un auto usado: Arrendamiento con derecho a compra o “leasing”     Bajo la Ley de Arrendamientos del Consumidor (CLA, por sus siglas en ingles), la persona o compania de quien usted hace el leasing de un vehiculo, conocida como el "arrendador", debera informar por escrito ciertos costos y plazos si el leasing es de mas de cuatro meses y si cumple con otros requisitos. La mayoria de los arrendamientos de vehiculos esta sujeta a la CLA. Los siguientes materiales le pueden ayudar a entender los terminos de su contrato de leasing. En el sitio web Comprenda como funciona la financiacion de vehiculos de la Comision Federal de Comercio se ofrece la siguiente informacion en espanol: Antes de comprar un vehiculo o hacer un leasing Deberia hacer un leasing para un vehiculo? Glosario de terminos especificos Mas informacion en espanol de GobiernoUSA.gov: Consejos para comprar un auto usado: Arrendamiento con derecho a compra o leasing ¿Cómo puedo averiguar el significado de los términos de mi contrato de leasing? Como puedo averiguar el significado de los terminos de mi contrato de leasing?",
-      question: "¿Cómo puedo averiguar el significado de los términos de mi contrato de leasing?"
+      "url": "https://www.consumerfinance.gov/es/obtener-respuestas/como-puedo-averiguar-el-significado-de-los-terminos-de-mi-contrato-de-leasing-es-2047/",
+      "text": " Bajo la Ley de Arrendamientos del Consumidor (CLA, por sus siglas en inglés), la persona o compañía de quien usted hace el leasing de un vehículo, conocida como el \"arrendador\", deberá informar por escrito ciertos costos y plazos si el leasing es de más de cuatro meses y si cumple con otros requisitos. La mayoría de los arrendamientos de vehículos está sujeta a la CLA. Los siguientes materiales le pueden ayudar a entender los términos de su contrato de leasing. En el sitio web Comprenda cómo funciona la financiación de vehículos de la Comisión Federal de Comercio se ofrece la siguiente información en español: Antes de comprar un vehículo o hacer un leasing ¿Debería hacer un leasing para un vehículo? Glosario de términos específicos Más información en español de GobiernoUSA.gov: Consejos para comprar un auto usado: Arrendamiento con derecho a compra o “leasing”     Bajo la Ley de Arrendamientos del Consumidor (CLA, por sus siglas en ingles), la persona o compania de quien usted hace el leasing de un vehiculo, conocida como el \"arrendador\", debera informar por escrito ciertos costos y plazos si el leasing es de mas de cuatro meses y si cumple con otros requisitos. La mayoria de los arrendamientos de vehiculos esta sujeta a la CLA. Los siguientes materiales le pueden ayudar a entender los terminos de su contrato de leasing. En el sitio web Comprenda como funciona la financiacion de vehiculos de la Comision Federal de Comercio se ofrece la siguiente informacion en espanol: Antes de comprar un vehiculo o hacer un leasing Deberia hacer un leasing para un vehiculo? Glosario de terminos especificos Mas informacion en espanol de GobiernoUSA.gov: Consejos para comprar un auto usado: Arrendamiento con derecho a compra o leasing ¿Cómo puedo averiguar el significado de los términos de mi contrato de leasing? Como puedo averiguar el significado de los terminos de mi contrato de leasing?",
+      "question": "¿Cómo puedo averiguar el significado de los términos de mi contrato de leasing?"
     }
   ]
 }

diff --git a/docs/housing-counselor-tool.md b/docs/housing-counselor-tool.md
@@ -75,38 +75,38 @@ It returns thousands of results like this:
 
 ```json
 {
-    "services": "DFC,FBC,PPC,RHC",
-    "languages": "ENG,SPA",
-    "agc_STATUS": "A",
-    "agc_SRC_CD": "HUD",
-    "counslg_METHOD": "Face to Face Counseling,Group Counseling,Phone Counseling",
-    "agcid": "80790",
-    "adr1": "1234 N. Example St.",
-    "adr2": " ",
-    "city": "SPRINGFIELD",
-    "email": "[email protected]",
-    "fax": "999-888-7777",
-    "nme": "EXAMPLE COMMUNITY HOUSING SERVICES",
-    "phone1": "111-222-3333",
-    "statecd": "MI",
-    "weburl": "www.example.org",
-    "zipcd": "48219-8888",
-    "agc_ADDR_LATITUDE": "42.442658",
-    "agc_ADDR_LONGITUDE": "-83.28329",
-    "parentid": "81228",
-    "county_NME": "",
-    "phone2": " ",
-    "mailingadr1": "1234 N. Example St.",
-    "mailingadr2": " ",
-    "mailingcity": "SPRINGFIELD",
-    "mailingzipcd": "48219-8888",
-    "mailingstatecd": "MI",
-    "state_NME": "Michigan",
-    "state_FIPS_CODE": null,
-    "faithbased": "N",
-    "colonias_IND": "Y",
-    "migrantwkrs_IND": "N"
-},
+  "services": "DFC,FBC,PPC,RHC",
+  "languages": "ENG,SPA",
+  "agc_STATUS": "A",
+  "agc_SRC_CD": "HUD",
+  "counslg_METHOD": "Face to Face Counseling,Group Counseling,Phone Counseling",
+  "agcid": "80790",
+  "adr1": "1234 N. Example St.",
+  "adr2": " ",
+  "city": "SPRINGFIELD",
+  "email": "[email protected]",
+  "fax": "999-888-7777",
+  "nme": "EXAMPLE COMMUNITY HOUSING SERVICES",
+  "phone1": "111-222-3333",
+  "statecd": "MI",
+  "weburl": "www.example.org",
+  "zipcd": "48219-8888",
+  "agc_ADDR_LATITUDE": "42.442658",
+  "agc_ADDR_LONGITUDE": "-83.28329",
+  "parentid": "81228",
+  "county_NME": "",
+  "phone2": " ",
+  "mailingadr1": "1234 N. Example St.",
+  "mailingadr2": " ",
+  "mailingcity": "SPRINGFIELD",
+  "mailingzipcd": "48219-8888",
+  "mailingstatecd": "MI",
+  "state_NME": "Michigan",
+  "state_FIPS_CODE": null,
+  "faithbased": "N",
+  "colonias_IND": "Y",
+  "migrantwkrs_IND": "N"
+}
 ```
 
 Next, we replace the `languages` value with the full language names.

diff --git a/docs/javascript-unit-tests.md b/docs/javascript-unit-tests.md
@@ -164,8 +164,8 @@ to save and commit your changes.
    The line should now read:
 
    ```js
-   it( 'should return a string with expected value', () => {
-     …
+   it('should return a string with expected value', () => {
+     // …
    });
    ```
 
@@ -216,38 +216,13 @@ include the JavaScript file that you are testing.
 Additional dependencies should be added in the same manner.
 
 ```js
+// This file has a default export.
 import sample from '../../../../cfgov/unprocessed/js/modules/sample.js';
-```
-
-Some test files use `const` declarations to
-`require` scripts instead of `import`,
-because those files were written before `import` was available.
-We prefer to use `import` because it allows for tree shaking,
-meaning if two modules are importing the same module
-it should only be included in the bundle once,
-whereas with `require` it would be included twice.
 
-A consequence is that variables can’t be used in the import path,
-as they prevent Webpack from figuring out which modules are duplicates.
-For example, this snippet shows how a `require` statement
-should be converted to an `import` statement,
-but without including the `BASE_JS_PATH` variable in the file path:
-
-```js
-// This works, but could duplicate footer-button.js, if other files also require it.
-const FooterButton = require( BASE_JS_PATH + 'modules/footer-button.js' );
-
-// This doesn't work and the build will fail.
-import * as FooterButton from BASE_JS_PATH + 'modules/footer-button.js';
-
-// This is ugly, but it works and supports tree shaking.
-import * as FooterButton from '../../../../cfgov/unprocessed/js/modules/footer-button.js';
+// Or, if the file has a named export, that can be imported.
+import { sample } from '../../../../cfgov/unprocessed/js/modules/sample.js';
 ```
 
-`import` also provides a benefit in that you can choose specific parts
-of a module so that you only import the dependencies you need.
-For testing purposes, we will typically import the whole module
-to make sure we have full test coverage.
 [Read the `import` reference guide on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)
 on how to implement `import` for different use cases.
 
@@ -264,8 +239,8 @@ For the sample, the name of our module is `sample`,
 so we set this up on line 4 of `sample-spec.js`:
 
 ```js
-describe( 'sample', () => {
-  …
+describe('sample', () => {
+  // …
 });
 ```
 
@@ -493,18 +468,18 @@ const HTML_SNIPPET = `
   </div>
 `;
 
-describe( 'Notification', () => {
+describe('Notification', () => {
   let notificationElem;
   let notification;
   let thisNotification;
 
-  beforeEach( () => {
+  beforeEach(() => {
     document.body.innerHTML = HTML_SNIPPET;
-    notificationElem = document.querySelector( `.${ BASE_CLASS }` );
-    notification = new Notification( notificationElem, BASE_CLASS, {});
+    notificationElem = document.querySelector(`.${BASE_CLASS}`);
+    notification = new Notification(notificationElem, BASE_CLASS, {});
   });
 
-  …
+  // …
 });
 ```
 
@@ -537,30 +512,24 @@ Further down, here are some of the tests that cover the `_setType` function
 wraps both `_setType` and `_setContent`):
 
 ```js
-describe( 'setTypeAndContent()', () => {
-  it( 'should update the notification type for the success state', () => {
+describe('setTypeAndContent()', () => {
+  it('should update the notification type for the success state', () => {
     notification.init();
 
-    notification.setTypeAndContent(
-      notification.SUCCESS,
-      ''
-    );
+    notification.setTypeAndContent(notification.SUCCESS, '');
 
-    expect( notificationElem.classList ).toContain( 'm-notification--success' );
+    expect(notificationElem.classList).toContain('m-notification--success');
   });
 
-  it( 'should update the notification type for the warning state', () => {
+  it('should update the notification type for the warning state', () => {
     notification.init();
 
-    notification.setTypeAndContent(
-      notification.WARNING,
-      ''
-    );
+    notification.setTypeAndContent(notification.WARNING, '');
 
-    expect( notificationElem.classList ).toContain( 'm-notification--warning' );
+    expect(notificationElem.classList).toContain('m-notification--warning');
   });
 
-  …
+  // …
 });
 ```