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

Setup/teardown methods not mentioned in class docs #22

Open
codefrau opened this issue Jul 16, 2022 · 3 comments
Open

Setup/teardown methods not mentioned in class docs #22

codefrau opened this issue Jul 16, 2022 · 3 comments

Comments

@codefrau
Copy link
Member

These are essential methods to override so should be documented.

@yoshikiohshima
Copy link
Contributor

Where would be the "class docs"? IOW, where would we write it? They are mentioned but not in a reference manual style.

@codefrau
Copy link
Member Author

Maybe as an abstract base class? I think behaviors might be more understandable if they were declared like class MyActor extends ActorBehavior or something like that and then we could document all the methods in ActorBehavior (possibly including the Card methods reachable via this?)

Alternatively, they could be empty stubs in CardActor so they would be listed in https://croquet.io/docs/microverse/CardActor.html as overridable in behaviors. Since this in a behavior refers to (a proxy of) the Card that might make sense, too.

@yoshikiohshima
Copy link
Contributor

Yeah, having a dummy base classes might help the editor and documentation. Anselm had some ideas about that under different names but ActorBehavior and PawnBehavior would be much better names. a bit of trouble would be that the editor still have to find it and it might involve import and those and that makes other parts more complex.

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

2 participants