aboutsummaryrefslogtreecommitdiffgithub
diff options
context:
space:
mode:
authorAustin Adams <git@austinjadams.com>2018-09-06 13:44:59 -0400
committerAustin Adams <git@austinjadams.com>2018-09-06 13:44:59 -0400
commitd13b751f9a4ba539c954633fb1ef7fe81c1e0b56 (patch)
tree6bef378966617c30132b2c9bd6fa22cde612dbaa
parent4f8c97233f7fb0bc85073bd5106d1b770fae3bbb (diff)
downloadcircuitsim-grader-template-d13b751f9a4ba539c954633fb1ef7fe81c1e0b56.tar.gz
circuitsim-grader-template-d13b751f9a4ba539c954633fb1ef7fe81c1e0b56.tar.xz
Update incorrect documentation about component whitelists
Somehow this got out of sync with the code.
-rw-r--r--README.md17
-rw-r--r--src/main/java/edu/gatech/cs2110/circuitsim/api/SubcircuitTest.java12
2 files changed, 12 insertions, 17 deletions
diff --git a/README.md b/README.md
index b4eb4bd..cfd8e13 100644
--- a/README.md
+++ b/README.md
@@ -170,17 +170,12 @@ gate component. Then we can change the `@SubcircuitTest` annotation as follows:
blacklistedComponents={"XOR"})
```
-You can write either components or component categories, like "Wiring." There
-is also a complementary but mutually exclusive flag, `whitelistedComponents`,
-which sets the only components allowed. But as the Javadoc warns,
-
-> [`whitelistedComponents`] has no common sense, so to speak. Subcircuit
-> components are always allowed, but other components will be allowed only if
-> you specify them here, including Wiring components. Please consider starting
-> off with
-> `whitelistedComponents={"Input Pin", "Output Pin", "Constant", "Probe", "Splitter", "Tunnel"}`
-> (or if you're okay with transistors, `whitelistedComponents={"Wiring"}` is
-> shorter) at the minimum, or you will risk frustrating students.
+You can write either components or component categories, like "Wiring."
+There is also a complementary but mutually exclusive flag,
+`whitelistedComponents`, which sets the only components allowed. To
+avoid code duplication, it allows Input Pins, Output Pins, Constants,
+and Tunnels automatically. But I would go ahead and write
+`whitelistedComponents={"Wiring"}` so they can use probes, for example.
#### Testing sequential logic
diff --git a/src/main/java/edu/gatech/cs2110/circuitsim/api/SubcircuitTest.java b/src/main/java/edu/gatech/cs2110/circuitsim/api/SubcircuitTest.java
index 8291bac..7fa24eb 100644
--- a/src/main/java/edu/gatech/cs2110/circuitsim/api/SubcircuitTest.java
+++ b/src/main/java/edu/gatech/cs2110/circuitsim/api/SubcircuitTest.java
@@ -43,12 +43,12 @@ public @interface SubcircuitTest {
* these components or categories.
* Mutually exclusive with {@link #blacklistedComponents()}.
* <p>
- * This feature has no common sense, so to speak. Subcircuit components are
- * always allowed, but other components will be allowed only if you specify
- * them here, including Wiring components. Please consider starting off with
- * {@code whitelistedComponents={"Input Pin", "Output Pin", "Constant", "Probe", "Splitter", "Tunnel"}}
- * (or if you're okay with transistors, {@code whitelistedComponents={"Wiring"}} is shorter)
- * at the minimum, or you will risk frustrating students.
+ * Automatically includes Input Pins, Output Pins, Constants, and
+ * Tunnels. always allowed. But other components will be allowed
+ * only if you specify them here, including other Wiring components.
+ * Please consider starting off with {@code
+ * whitelistedComponents={"Wiring"}}, or you will risk frustrating
+ * students.
*
* @return list of required component names or component category names
*/