Skip to content

stub_template #369

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

Merged
merged 8 commits into from
Aug 4, 2019
Merged

stub_template #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f482598
remove example.sh stub; add stub_template
guygastineau Aug 3, 2019
bfbdf13
renamed to exercise_stub
guygastineau Aug 3, 2019
350a1a0
revised
guygastineau Aug 4, 2019
cf0f064
shortened version
guygastineau Aug 4, 2019
fe9ea02
used Bash the proper noun for the language not the executable
guygastineau Aug 4, 2019
386b99a
removed link
guygastineau Aug 4, 2019
f554053
added quotes to raw
guygastineau Aug 4, 2019
1574653
indent blcok in main
guygastineau Aug 4, 2019
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
22 changes: 0 additions & 22 deletions _template/example.sh
View file
Open in desktop

This file was deleted.

24 changes: 24 additions & 0 deletions _template/exercise_stub
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/usr/bin/env bash

# This stub should help you get started:
# - Bash is flexible. You may use functions or write a "raw" script.
#
# - Complex code can be made easier to read by breaking it up
# into functions, however this is sometimes overkill in bash.
#
# - You can find links about good style and other resources
# for Bash in './README.md'. It came with this exercise.
#
# Example:
# # other functions here
# # ...
# # ...
#
# main () {
# # your main function code here
# }
#
# # call main with all of the positional arguments
# main "$@"
#
# *** REMOVE THIS STUB BEFORE SUBMITTING YOUR SOLUTION FOR MENTORING ***
Copy link
Member

Choose a reason for hiding this comment

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

Maybe move the general guidance into the bash template that shows up on the exercise description and make the stub a lot more ... stub-like? Short, sweet and simple without a repetitive wall of text that need to delete every exercise?

#!/usr/bin/env bash

main () {
  # your code here
}

main "$@"

Copy link
Contributor Author

@guygastineau guygastineau Aug 3, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

We can work on that.

With our current testing set up I don't want the student to feel pressured into using functions. That is why I commented the whole thing.

Copy link
Contributor Author

@guygastineau guygastineau Aug 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

If we move to a library testing model for our exercises, then all of these will change. Then our stubs will simply give the skeleton of the API that our lib needs, and these stubs will be irrelevant.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately, we would still need to use a message telling students to delete the stub comments no matter how short the stub is.

In the example you give above at least 2 in 10 people will leave the # your code here line in their file.

Copy link
Contributor Author

@guygastineau guygastineau Aug 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

I want to be clear, @IsaacG, that your suggestion here is ideal. Once #366 is resolved the stubs won't be throw away anymore.

I am mostly trying to satisfy #365 in the meantime.

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 trimmed out some of the verbosity ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Does 24 lines make you feel better about this than 32?