Development tools
In this section, I want to introduce some factors that should be considered when creating code for others to use and possibly contribute to, which will not necessarily be as strictly adhered to here as we are doing so for our own usage.
These cover topics such as documentation, debugging, revision, and profiling, together with some degree of standardization, which I will tackle here, but not necessarily in that order. For an actual example of creating a package, that will be deferred until the following section.
Document strings
It is pantomime season in the UK at present, and I with my family go every year to the current offering in Wimbledon. All children over the age of 2 love it, although hopefully they don’t get all the jokes, and it gives the adults (who mostly do) a chance to go as well.
So, for some of the rest of this chapter, I am using a file introduced in the preceding getopt.jl
example, panto.jl
, with three pantomime characters: Aladdin...