Action icon indicating copy to clipboard operation
Action copied to clipboard

Provide behavioural documentation and unit testing for public API

Open mosamer opened this issue 8 years ago • 1 comments

While the library API is pretty stable, some fixes and refactoring introduced some breaking changes to its behavior (e.g. removing replay from elements). Also, while the overall usage is well documented with examples, this might not be the case for how exposed properties are behaving.

It is required to provide a documentation for how public API properties should behave along with corresponding unit tests to reflect this behavior to avoid any regressions during future refactoring. Candidate members include;

  • elements
  • inputs
  • errors
  • executing
  • func execute(_:)

mosamer avatar Nov 02 '17 19:11 mosamer

related to #120 & #27

mosamer avatar Nov 02 '17 19:11 mosamer