run_capsule.py has code that should not be modified by the user. This code parses inputs, checks for processing records on docdb. What is confusing is that some of it is in the main block, and some of it is in run_analysis().
-
I think all capsule code that should not be modified should be in the main block, and all code written by the user should be in run_analysis(). That way when a user copies this capsule, the run_analysis() function will be blank and they won't need to figure out what code can be deleted and what must be kept.
-
I would also add verbose comments to the code that remains in the main block for ease of understanding on the user's part.
run_capsule.pyhas code that should not be modified by the user. This code parses inputs, checks for processing records on docdb. What is confusing is that some of it is in themainblock, and some of it is inrun_analysis().I think all capsule code that should not be modified should be in the
mainblock, and all code written by the user should be inrun_analysis(). That way when a user copies this capsule, the run_analysis() function will be blank and they won't need to figure out what code can be deleted and what must be kept.I would also add verbose comments to the code that remains in the main block for ease of understanding on the user's part.