search

tszanalytics / BayesTesting.jl

Other
15 stars 2 forks source link

Code documentation and parameter names #8

Open DominiqueMakowski opened 6 years ago

DominiqueMakowski commented 6 years ago

It would be easier for external users to read the code if some important steps were documented (with a comment).

Most importantly, it would be useful to write variable names with full and explicit names: For instance, in correlation_test, variable names are s2, vb, seb, that,ts, ps, qs, etc. which are quite opaque (for non-experts) and difficult to interpret, thus it's complicated to understand the internals of a function. Examples of more explicit names are pvalue, posterior, residuals, CI (credible interval), tvalue etc.

tszanalytics commented 6 years ago

Yes, excellent idea. I will go through functions and start doing this.