Merge pull request #190 from eecs280staff/cla-example

jamesjuett · web-flow · commit 90d0d2a34998 · 2024-08-27T13:43:53.000-04:00
Use P1 for Command-Line Argument Example
diff --git a/docs/images/visualstudio149.png b/docs/images/visualstudio149.png
diff --git a/docs/images/xcode259.png b/docs/images/xcode259.png
diff --git a/docs/setup_gdb.md b/docs/setup_gdb.md
@@ -92,21 +92,26 @@ We recommend enabling the address sanitizer and undefined behavior sanitizer. Th
 
 First, edit your `Makefile` and add the `CXXFLAGS` recommended by the [ASAN Quick Start](setup_asan.html#quick-start).
 
-### Arguments and options
-Arguments and options are inputs to a program typed at the command line.  Here's an example from EECS 280 Project 4:
+### Command-Line Arguments and Options
+
+<!-- Preserve links to old section heading "Arguments and Options" -->
+<a id="arguments-and-options"></a>
+
+Inputs to a program may be provided when it is initially run via command-line arguments or options. Here's an example from EECS 280 Project 1:
+
 ```console
-$ ./main.exe train_small.csv test_small.csv --debug
+$ ./two_sample.exe HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
-{: data-variant="no-line-numbers" data-highlight="1" }
 
-- `main.exe` is the name of the program
-- `train_small.csv` and `test_small.csv` are arguments
-- `--debug` is an option
+- `./two_sample.exe` is used to run the program
+- Each of `HCMST_ver_3.04.tsv`, `q24_met_online`, `1`, `0`, `ppage` are passed to it as arguments
+
+The arguments above specify the name of a data file, coulumns, and filter values for the program to use.
 
-To run a program with options or arguments in LLDB, inc
+To run a program with options or arguments in GDB, include them after `r`.
 ```console
 $ gdb main.exe
-(gdb) r train_small.csv test_small.csv --debug
+(gdb) r HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
 {: data-highlight="2" }
 
diff --git a/docs/setup_lldb.md b/docs/setup_lldb.md
@@ -91,21 +91,26 @@ We recommend enabling the address sanitizer and undefined behavior sanitizer. Th
 
 First, edit your `Makefile` and add the `CXXFLAGS` recommended by the [ASAN Quick Start](setup_asan.html#quick-start).
 
-### Arguments and options
-Arguments and options are inputs to a program typed at the command line.  Here's an example from EECS 280 Project 4:
+### Command-Line Arguments and Options
+
+<!-- Preserve links to old section heading "Arguments and Options" -->
+<a id="arguments-and-options"></a>
+
+Inputs to a program may be provided when it is initially run via command-line arguments or options. Here's an example from EECS 280 Project 1:
+
 ```console
-$ ./main.exe train_small.csv test_small.csv --debug
+$ ./two_sample.exe HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
-{: data-variant="no-line-numbers" data-highlight="1" }
 
-- `main.exe` is the name of the program
-- `train_small.csv` and `test_small.csv` are arguments
-- `--debug` is an option
+- `./two_sample.exe` is used to run the program
+- Each of `HCMST_ver_3.04.tsv`, `q24_met_online`, `1`, `0`, `ppage` are passed to it as arguments
+
+The arguments above specify the name of a data file, coulumns, and filter values for the program to use.
 
 To run a program with options or arguments in LLDB, include them after `r`.
 ```console
 $ lldb main.exe
-(lldb) r train_small.csv test_small.csv --debug
+(lldb) r HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
 {: data-highlight="2" }
 
diff --git a/docs/setup_visualstudio.md b/docs/setup_visualstudio.md
@@ -209,20 +209,25 @@ Visual Studio provides an address sanitizer with bounds checking automatically w
 
 </div>
 
-### Arguments and options
+### Command-Line Arguments and Options
+
+<!-- Preserve links to old section heading "Arguments and Options" -->
+<a id="arguments-and-options"></a>
+
 <div class="primer-spec-callout info" markdown="1">
 Skip this subsection your first time through the tutorial.  You can come back to it.
 </div>
 
-Arguments and options are inputs to a program typed at the command line.  Here's an example from EECS 280 Project 4:
+Inputs to a program may be provided when it is initially run via command-line arguments or options. Here's an example from EECS 280 Project 1:
+
 ```console
-$ ./main.exe train_small.csv test_small.csv --debug
+$ ./two_sample.exe HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
-{: data-variant="no-line-numbers" data-highlight="1" }
 
-- `main.exe` is the name of the program
-- `train_small.csv` and `test_small.csv` are arguments
-- `--debug` is an option
+- `./two_sample.exe` is used to run the program
+- Each of `HCMST_ver_3.04.tsv`, `q24_met_online`, `1`, `0`, `ppage` are passed to it as arguments
+
+The arguments above specify the name of a data file, coulumns, and filter values for the program to use.
 
 Right-click the project in the Solution Explorer (`p1-stats` in this example).  Select "Properties".
 
diff --git a/docs/setup_vscode_macos.md b/docs/setup_vscode_macos.md
@@ -303,29 +303,34 @@ Open Settings on VSCode (Code > Settings > Settings). Search for "lldb: show dis
 
 <img src="images/vscode_macos_037.png" width="768px" />
 
-### Arguments and options
+### Command-Line Arguments and Options
+
+<!-- Preserve links to old section heading "Arguments and Options" -->
+<a id="arguments-and-options"></a>
+
 <div class="primer-spec-callout info" markdown="1">
 Skip this subsection your first time through the tutorial.  You can come back to it.
 </div>
 
-Arguments and options are inputs to a program typed at the command line.  Here's an example from EECS 280 Project 4:
+Inputs to a program may be provided when it is initially run via command-line arguments or options. Here's an example from EECS 280 Project 1:
+
 ```console
-$ ./main.exe train_small.csv test_small.csv --debug
+$ ./two_sample.exe HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
-{: data-variant="no-line-numbers" data-highlight="1" }
 
-- `main.exe` is the name of the program
-- `train_small.csv` and `test_small.csv` are arguments
-- `--debug` is an option
+- `./two_sample.exe` is used to run the program
+- Each of `HCMST_ver_3.04.tsv`, `q24_met_online`, `1`, `0`, `ppage` are passed to it as arguments
+
+The arguments above specify the name of a data file, coulumns, and filter values for the program to use.
 
-To run a program with options or arguments in VS Code, edit `launch.json`.  Each option or argument should goes in a separate comma-separated string.
+To run a program with options or arguments in VS Code, edit `launch.json`.  Each option or argument goes in a separate comma-separated string.
 ```json
 {
     "configurations": [
         {
             ...
             "program": "${workspaceFolder}/main.exe",
-            "args": ["train_small.csv", "test_small.csv", "--debug"],
+            "args": ["HCMST_ver_3.04.tsv", "q24_met_online", "1", "0", "ppage"],
             ...
         }
     ]
diff --git a/docs/setup_vscode_wsl.md b/docs/setup_vscode_wsl.md
@@ -373,29 +373,34 @@ Edit the `"environment"` property in your `launch.json`.  If there's already an
 ```
 {: data-highlight="3-4" }
 
-### Arguments and options
+### Command-Line Arguments and Options
+
+<!-- Preserve links to old section heading "Arguments and Options" -->
+<a id="arguments-and-options"></a>
+
 <div class="primer-spec-callout info" markdown="1">
 Skip this subsection your first time through the tutorial.  You can come back to it.
 </div>
 
-Arguments and options are inputs to a program typed at the command line.  Here's an example from EECS 280 Project 4:
+Inputs to a program may be provided when it is initially run via command-line arguments or options. Here's an example from EECS 280 Project 1:
+
 ```console
-$ ./main.exe train_small.csv test_small.csv --debug
+$ ./two_sample.exe HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
-{: data-variant="no-line-numbers" data-highlight="1" }
 
-- `main.exe` is the name of the program
-- `train_small.csv` and `test_small.csv` are arguments
-- `--debug` is an option
+- `./two_sample.exe` is used to run the program
+- Each of `HCMST_ver_3.04.tsv`, `q24_met_online`, `1`, `0`, `ppage` are passed to it as arguments
+
+The arguments above specify the name of a data file, coulumns, and filter values for the program to use.
 
-To run a program with options or arguments in VS Code, edit `launch.json`.  Each option or argument should goes in a separate comma-separated string.
+To run a program with options or arguments in VS Code, edit `launch.json`.  Each option or argument goes in a separate comma-separated string.
 ```json
 {
     "configurations": [
         {
             ...
             "program": "${workspaceFolder}/main.exe",
-            "args": ["train_small.csv", "test_small.csv", "--debug"],
+            "args": ["HCMST_ver_3.04.tsv", "q24_met_online", "1", "0", "ppage"],
             ...
         }
     ]
diff --git a/docs/setup_xcode.md b/docs/setup_xcode.md
@@ -229,20 +229,25 @@ Select your scheme, then "Edit Scheme".  You can also use menu: Product > Scheme
 
 <img src="images/xcode170.png" width="768px" />
 
-### Arguments and options
+### Command-Line Arguments and Options
+
+<!-- Preserve links to old section heading "Arguments and Options" -->
+<a id="arguments-and-options"></a>
+
 <div class="primer-spec-callout info" markdown="1">
 Skip this subsection your first time through the tutorial.  You can come back to it.
 </div>
 
-Arguments and options are inputs to a program typed at the command line.  Here's an example from EECS 280 Project 4:
+Inputs to a program may be provided when it is initially run via command-line arguments or options. Here's an example from EECS 280 Project 1:
+
 ```console
-$ ./main.exe train_small.csv test_small.csv --debug
+$ ./two_sample.exe HCMST_ver_3.04.tsv q24_met_online 1 0 ppage
 ```
-{: data-variant="no-line-numbers" data-highlight="1" }
 
-- `main.exe` is the name of the program
-- `train_small.csv` and `test_small.csv` are arguments
-- `--debug` is an option
+- `./two_sample.exe` is used to run the program
+- Each of `HCMST_ver_3.04.tsv`, `q24_met_online`, `1`, `0`, `ppage` are passed to it as arguments
+
+The arguments above specify the name of a data file, coulumns, and filter values for the program to use.
 
 Select your scheme, then "Edit Scheme".  You can also use menu: Product > Scheme > Edit Scheme.
 
