Plans for v0.3

[trystyncote]

Though the "version 0.3" has been being worked on for a while, I'd like to more thoroughly define what I want with this versioning.

The Plan

The plan with this version is primarily to do with the qualms module. Qualms are an object type that stores data about when something seems wrong. This could be anything from a visual glitch to a something being excluded due to a quirk of the instructions. Of course, raising an error is... not ideal, especially since the user will have little idea what is going wrong. Instead, Qualm objects will be returned, so the user can use the objects as a way to figure out if anything went wrong. It is up to the user to resolve any qualms they receive.

qualms

The qualms module must meet two requirements: first, the objects must be defined to be able to store enough data about what went wrong (primarily index, and any relevant objects). Second, the objects must be checked when compiling inside of compile_video().

• Defined Qualm objects;
• Qualm objects are checked for in compile_video();

Framework for Documentation (#14)

The documentation is going to be a critical part if Scrivid will ever see use. While this functionality is intuitive to me, it will not be intuitive for everyone without explanation. While I don't wish to write a full set of documentation while functionality will be constantly be changing, the framework for it will be needed.

• Implemented

Restructure calls to References and Adjustments (#12)

Generally, having a series of names unpacked into the general namespace isn't that detrimental in small projects. But, as the project grew, this stopped being true, and the unpacking was overloading the namespace with variables and names that make searching difficult. So, I wanted to restructured namespaces to behave differently: scrivid.adjustments.core.MoveAdjustment instead of scrivid.MoveAdjustment, for instance.

More information in Issue #12

• Implemented

Restructure ImageReference (#16)

ImageReference has a lot of critical issues. I think that fixing these issues in version 0.3, before AudioReference is to be implemented in 0.4, would be a good idea.

• Implemented

:)