From 2a4616a04f8993699b62833db5cf214bf2dc1e30 Mon Sep 17 00:00:00 2001 From: Katherine Langford Date: Wed, 28 Jan 2026 10:11:50 +0000 Subject: [PATCH] CLDC-NONE: Lint fixes --- docs/dev_tasks/index.md | 1 - docs/dev_tasks/new_sales_question.md | 4 ++-- docs/form/question.md | 2 +- docs/setup.md | 4 ++-- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/dev_tasks/index.md b/docs/dev_tasks/index.md index ca53fc7da..1eeea9e77 100644 --- a/docs/dev_tasks/index.md +++ b/docs/dev_tasks/index.md @@ -6,4 +6,3 @@ nav_order: 14 # Common dev tasks A collection of guides for tasks that may have to be carried out repeatedly. - diff --git a/docs/dev_tasks/new_sales_question.md b/docs/dev_tasks/new_sales_question.md index 5b7c67032..f249b871e 100644 --- a/docs/dev_tasks/new_sales_question.md +++ b/docs/dev_tasks/new_sales_question.md @@ -90,7 +90,7 @@ Copy the entry for an existing question and substitute in the text for your new The fields that get exported in CSVs and XMLs are defined in `app/services/exports/sales_log_export_constants.rb`. -If there is not a set for POST__EXPORT_FIELDS, create one. Add your new field to the current year's set. +If there is not a set for POST\_\_EXPORT_FIELDS, create one. Add your new field to the current year's set. You may also have to update the `sales_log_export_service.rb` to correctly filter the year-specific fields. @@ -112,7 +112,7 @@ You will need to add a new `field_XXX` for the new field. In total, update the f You may also have to add some additional validation rules in this file. -Validation for ensuring that the value uploaded is one of the permitted options is handled automatically, using the question class as the original source of truth. +Validation for ensuring that the value uploaded is one of the permitted options is handled automatically, using the question class as the original source of truth. ### 9. Update unit tests diff --git a/docs/form/question.md b/docs/form/question.md index a40509757..fff9dd52d 100644 --- a/docs/form/question.md +++ b/docs/form/question.md @@ -6,7 +6,7 @@ nav_order: 4 # Question -*Updated for 2026.* +_Updated for 2026._ Questions are under the page level of the form definition. diff --git a/docs/setup.md b/docs/setup.md index b85f4d6ee..52f1da3b0 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -20,9 +20,9 @@ We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage NodeJS version ## Instructions for Windows users -If you are working on a windows machine, you will want to install the tools on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) as some of them are not native to windows. The instructions in these docs assume a Debian-based distribution, such as Ubuntu. +If you are working on a windows machine, you will want to install the tools on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) as some of them are not native to windows. The instructions in these docs assume a Debian-based distribution, such as Ubuntu. -*You will see a significant performance degradation if you are running the server on WSL whilst the files are on windows.* Thus, make sure to clone the repository into your WSL instance. +_You will see a significant performance degradation if you are running the server on WSL whilst the files are on windows._ Thus, make sure to clone the repository into your WSL instance. Some windows IDEs, such as [VSCode](https://code.visualstudio.com/docs/remote/wsl) and [RubyMine](jetbrains.com/help/ruby/remote-development-starting-page.html#run_in_wsl_ij) can connect you to WSL, which will allow you to develop as though the files were on the local windows filesystem. Ignore any reccommendations that you might see suggesting you keep the files on windows - our experience is that both tests and page loads are much slower when the files are on windows.