Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Provide behavioural documentation and unit testing for public API #121

Open
mosamer opened this issue Nov 2, 2017 · 1 comment
Open

Provide behavioural documentation and unit testing for public API #121

mosamer opened this issue Nov 2, 2017 · 1 comment
Labels
Approved
Milestone
Release-4.0

Comments

@mosamer
Copy link
Contributor

mosamer commented Nov 2, 2017

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
Copy link
Contributor Author

mosamer commented Nov 2, 2017

related to #120 & #27

@mosamer mosamer added this to the Release-4.0 milestone Nov 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Approved
Projects
None yet
Milestone
Release-4.0
Development

No branches or pull requests
2 participants
@bobgodwinx @mosamer