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.

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

Notebook function clarification needed #282

Open
nkorinek opened this issue May 15, 2020 · 0 comments
Open

Notebook function clarification needed #282

nkorinek opened this issue May 15, 2020 · 0 comments

Comments

@nkorinek
Copy link
Member

There are two functions in the notebook module that need clarification as to when they should be used and how.

  1. The error_test() function seems to only compare two numbers and see if they are equivalent or not. It prints out a custom error message based on the comparison. When is this used? Is there a way to make the code more robust to make it easier to incorporate into a work flow and make it's purpose more obvious?

  2. The remove_comments() function removes all commented lines in a string. When is this used in the workflow for notebook grading?
    Side note: The remove_comments() function used to leave empty spaces where it took out comments. I changed it so it deleted the line all together. The code used to look like this for records sake/if we decide to change it back:

return "".join([line.split("#")[0] for line in split_lines]) 

Clarification on these two functions would be greatly appreciated so we can document them better!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant