search

serverlesstechnology / cqrs

A lightweight, opinionated CQRS and event sourcing framework.
Other
370 stars 40 forks source link

remove doc modules #41

Closed danieleades closed 1 year ago

danieleades commented 1 year ago

opening this PR to start discussion

what are the doc/ modules for? Are they still required?

davegarred commented 1 year ago

These are used in some of the documentation in the persistence crates. I agree that this is ugly, I'm not sure of a better solution currently though without adding more duplication.

Combining all of the persistence crates would clear this up, but I don't know that that is a great idea at this time.

danieleades commented 1 year ago

could they be moved to an examples/ directory, instead of directly in the source?

danieleades commented 1 year ago

@davegarred I can move these modules into an example, but there's one catch- the persist/doc/ module depends on the crate-private persist::event_stream::ReplayStream, so a user of the library couldn't implement these examples as is. Is this type meant to be public?

have drafted what that would look like here - #45