Mirror update button description in public API of CodeExercise
#81
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To improve the API from a user perspective we use the same naming for public functions that update a `CodeExercise` instantce as the buttons as their description. This means renaming `run_update` to `run_code` and duplicating the functionality of the `run_update` with the function `update`, since the update button is called "Update" when no `code` is given on initalization. Since `run_code` was already taken we rename it tc `call_code`
|
I am not so convinced that this is actually better. Since "run_update" is more transparent to the teacher who gives an update function that runs the code, so it describes more what happens. We decided for "Run code" in the naming of the button because for the student who never sees the construction of the widget this is more intuitive. We could rename |
|
I favor the change update_func to update in PR #85 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To improve the API from a user perspective we use the same naming for public functions that update a
CodeExerciseinstance as the buttons as their description. This means renamingrun_updatetorun_codeand duplicating the functionality of therun_updatewith the functionupdate, since the update button is called "Update" when nocodeis given on initialization. Sincerun_codewas already taken we rename it tocall_code