LaurierCS / PHI-TextBasedGameEngine

A text based game engine for creating games
4 stars 1 forks source link

Add code documentation #10

Closed jbheard closed 4 years ago

jbheard commented 4 years ago

We currently put documentation for how to use the project in /docs. It would be nice to also have documentation on our internal functions, classes, etc. This has a number of benefits, including:

If we do this, I think the best course of action is to have a github action that generates markdown & commits markdown files based on docstrings in the code.

We could write documentation separately from the code, but that has some drawbacks:

jbheard commented 4 years ago

This was resolved with the Build Documentation action I built.