ietoolkit icon indicating copy to clipboard operation
ietoolkit copied to clipboard

Command review checklist

Open luizaandrade opened this issue 5 years ago • 0 comments

Organization

  • [ ] Are the sections clear?
  • [ ] Is the code well documented?
  • [ ] Could modularization improve code readability?

Help file

  • [ ] Are all command options documented in the help file?

Test do-file

  • [ ] Is there a run file?
  • [ ] Is the run file replicable?
  • [ ] Does the run file test all options in the command?
  • [ ] Can you think of possible errors that are not tested in the run file?

Syntax

  • [ ] Are option names in line with typical Stata and ietoolkit naming practices? (think format, clear, force, using)
  • [ ] Do the options input format (string, numeric, varname, etc) make sense?
  • [ ] Do if statements exhaust the possibilities of option specification?

Command updates

  • [ ] Check backward compatibility

luizaandrade avatar Sep 07 '19 16:09 luizaandrade