Skip to content
This repository has been archived by the owner on Sep 14, 2024. It is now read-only.

In-depth documentation topic list #118

Open
MagiMaster opened this issue Jun 16, 2020 · 5 comments
Open

In-depth documentation topic list #118

MagiMaster opened this issue Jun 16, 2020 · 5 comments

Comments

@MagiMaster
Copy link
Collaborator

MagiMaster commented Jun 16, 2020

We should have more in-depth documentation on how to best use this library. This issue is to track which features/situations/edge cases are currently missing or under-explained. (If you haven't seen it, https://documentation.divio.com/ is a good reference for writing documentation in general.)

@MagiMaster
Copy link
Collaborator Author

The lifecycle hooks need to be added to the API reference, but they may also be worth a separate document as they may need more explanation of how best to use them than would be appropriate for a reference.

@MagiMaster
Copy link
Collaborator Author

A description of how spec-style tests are meant to be written (no real code in describe blocks), why that is, and how that applies specifically to Lua and TestEZ would be worthwhile. Might could be combined with the detailed explanation of the lifecycle hooks.

@MagiMaster
Copy link
Collaborator Author

The new context API needs to be documented. This would also tie in to the lifecycle hooks as that's a primary use case.

@benbrimeyer
Copy link
Collaborator

benbrimeyer commented Oct 2, 2020

I've documented some of this in #143 within the api reference.

We do still need a best practice guide for spec-style tests.

Lifecycle hooks are documented in the api reference, but not much beyond that.

@benbrimeyer
Copy link
Collaborator

We should also add documentation on how to mock more complex game orientated topics, like the passage of time.

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

No branches or pull requests

2 participants