Skip to content

Consitency of pyrandall documentation #2

Description

@stefanooldeman

Let's discuss consistency in naming and explaining of pyrandall.

A few Idea's

  • Sanitytest becomes Validate
  • Pyrandall, PYRANDALL, and pyrandall
  • The readme mentions BDD and test framework. But these are different things.
  • In terms of correctness, should we name pyrandall a framework, library, tool. Or avoid these things altogether. (needs a bit of research)

TODO's

  1. Decide on naming in this thread and propose changes to docstrings, README.md and CONTRIBUTING.md etc.

  2. Change github.com/pyrandall title text.
    See the subtext under pyrandall on this page: https://github.com/kpn, to see how it reads on a listing page:

    Currently: Pyrandall is a test framework with a focus on Event Streaming and Stream Processors.
    My suggestion:
    Drive the development of streaming architectures. Write specs to simulate and validate application state.

    I think I rather not mention too many details or labels as testing, event sourcing, framework, library, tool, etc. And explain those things in the README. Because this is easier to change / contribute to.

  3. Leave a comment to point out other inconsistencies and propose a way forward for the codebase

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions