Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Teacher tool: added two simple variable validator rules #9859

Merged
merged 3 commits into from
Feb 8, 2024
Merged

Teacher tool: added two simple variable validator rules #9859

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d7797e2
add simple variable validator
srietkerk Feb 7, 2024
b4f88ce
Merge branch 'master' of https://github.com/microsoft/pxt into srietk…
srietkerk Feb 7, 2024
9312064
Update catalog template to custom variable
srietkerk Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/teachertool/catalog-shared.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@
"use": "functions_have_comments",
"template": "All function definitions have comments",
"docPath": "/teachertool"
},
{
"id": "D21D76A2-D9FD-4F9B-B0AC-973CB870EA78",
"use": "variable_set",
"template": "At least one variable's value is set",
srietkerk marked this conversation as resolved.
Show resolved Hide resolved
"docPath": "/teachertool"
},
{
"id": "0173898D-8A48-4266-AAB9-CE934471A734",
"use": "variable_accessed",
"template": "At least one variable is accessed",
"docPath": "/teachertool"
}
]
}
26 changes: 26 additions & 0 deletions docs/teachertool/validator-plans-shared.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,32 @@
}
}
]
},
{
".desc": "A variable's value is set",
"name": "variable_set",
"threshold": 1,
"checks": [
{
"validator": "blocksExist",
"blockCounts": {
"variables_set": 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may want to add an additional check here for variables_change, which will also work as a set in some cases (but keep threshold as 1).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to keep that as a separate check and wait for feedback on it. It makes sense that we assign a variable a value when the variable is created so there are less errors. However, allowing a variables_change to act as a setter in a validation scenario feels like a dangerous thing to allow. The act of distinctively setting a variable value is a pretty important learning point for computer science.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can add a validator for variables_change, too, though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I don't think we need to add a whole separate validator for it. Feel free to leave as-is for now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validating that the program changes the value of a variable is actually non-trivial, since both "change" or "set" could do it, but "set" would have to be called twice on the same variable to achieve the intuitive result, which might be tricky to check. I'd only go down that rabbit hole if we get feedback asking for it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good. I'll leave as is, then. Will definitely want to revisit the "variable changed" validation in the future.

}
}
]
},
{
".desc": "A variable's value is used",
"name": "variable_accessed",
"threshold": 1,
"checks": [
{
"validator": "blocksExist",
"blockCounts": {
"variables_get": 1
}
}
]
}
]
}