apjanke / octave-testify

New BIST (Built-In Self Test) functions for GNU Octave
GNU General Public License v3.0
4 stars 2 forks source link

new name for runtests2 #88

Open mtmiller opened 5 years ago

mtmiller commented 5 years ago

There seems to be consensus so far that it would be good to avoid the name runtests in Octave.

I think Testify should perhaps lead the way on what the new name should be, or just go its own way and not try to shadow whatever name Octave chooses with a 2 suffix now. I don't really like the idea of oruntests.

If you agree, what should the MultiBistRunner porcelain command be named now?

apjanke commented 5 years ago

I think you're right.

I tend to think of the particular Octave-style tests as "BISTs", since that's what I've seen other people refer to them as in Savannah and mailing list discussions. So maybe runbists() or runbisttests()?

I have to admit that I'm still new enough to Octave programming that I haven't developed any "taste" for what makes a good or bad function name here.

mtmiller commented 5 years ago

I think the name should be an umbrella for all types of tests, whether they are BISTs or not, unit tests, smoke tests, regression tests, integration tests, etc.

One smell that distinguishes Octave names from Matlab names is the use of underscores for long compound names, while Matlab tends to follow Java style camelCase.

A dump of some ideas in no particular order

Thinking the name should emphasize a summary answer to "what does this function offer over test?" It runs all tests, it recurses over a project tree, it prints a test report, something like that.