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.

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

Unclear documentation / naming in turtle.env.model.Registry #55

Open
gavin-norman-sociomantic opened this issue Aug 2, 2018 · 1 comment

Comments

@gavin-norman-sociomantic
Copy link

gavin-norman-sociomantic commented Aug 2, 2018

The module doc says:

Provides centralized registry where turtle env additions from other libraries can register themselves for the purpose of being notified about test suite shutdown.

The one location where the Registry.unregisterAll method is called says:

before killing tested app, unregister all know environment additions to avoid irrelevant errors being printed because of shutdown sequence

The documentation of ITurtleEnv says:

Turtle environment addition must implement this interface to be able to be notified about test suite shutdown to adjust own state accordingly.

The documented purposes of the registry and the unregistration facility (bolded above) don't really seem to tie in. From the point of view of a user implementing ITurtleEnv, it's not clear what unregister is supposed to do.

@gavin-norman-sociomantic
Copy link
Author

(Guessing this is a result of refactoring.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant