canonical / checkbox

Checkbox
https://checkbox.readthedocs.io
GNU General Public License v3.0
30 stars 44 forks source link

What's plainbox? #1278

Closed waveform80 closed 1 week ago

waveform80 commented 3 weeks ago

Enhancement Proposal

As someone diving into checkbox for the first time, and attempting to define some new tests, I keep seeing references to "plainbox" (e.g. in the file format spec). Unfortunately, nowhere has actually defined what plainbox is. After a bit of digging I did discover the Launchpad page and was pleased to read it has a "well ... documented core". Unfortunately, I haven't manage to find those docs. I did find the PyPI page for the project which has several, unfortunately dead, documentation links.

If the answer is basically "it's the core of checkbox" and if plainbox isn't really a separate project at all any more (I see its last release on PyPI was 7 years ago, at the time of writing) perhaps it'd be better to just search'n'replace all those references in the docs and change them to "checkbox"?

I'm happy to file a PR for this, if this is desirable.

syncronize-issues-to-jira[bot] commented 3 weeks ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CHECKBOX-1462.

This message was autogenerated

Hook25 commented 2 weeks ago

Hello, you are right, there is no plainbox anymore, as in: our documentation should not reference it all over the place. If you are willing to, feel free to file a pr where you find/replace all occurrences with Checkbox. Do so only in the docs/ subdirectory, as in the code some plainbox still ramains separate.

As for what plainbox was: it was basically a base on top of which one could build a testing frameword. One such framework is Checkbox (and that we know of, the only one) . Most of this separation is gone nowadays because it caused (and still causes sometimes) quite a few headaches and complications without yielding any benefit.