esper icon indicating copy to clipboard operation
esper copied to clipboard

Rewrite Readme, docstrings, and create documentation.

Open anaselmi opened this issue 6 years ago • 3 comments

Readme: Readme needs rewritting and rewording. Multi-stage process and other parts of this issue are completed. Docstrings: Docstrings need to be reworded, rewritten, reformated, and in some cases, added. Might also add type hinting to certain methods. Documentaton: Docs will be based mostly off of docstrings, with light edits dependin on context.

anaselmi avatar Jun 22 '18 23:06 anaselmi

I'm happy to take a look at working on this. I've forked it. I'll start by adding Docstrings to missing functions.

jonathanabennett avatar Feb 11 '19 10:02 jonathanabennett

Sorry this has gone so long without attention. I'd be happy to have documentation contributions if something can be improved.

benmoran56 avatar Jan 01 '20 09:01 benmoran56

Some sort of tutorial would be a great addition as well, as ECS is a rather new and different way of thinking about game design, and there's a lot of newbies using python to develop their first games.

MrDowntempo avatar Nov 30 '20 06:11 MrDowntempo

I'm going to close this for now, as the README and docstrings have already been rewritten and improved. It should be a lot more comprehensive now, as compared to when this ticket was new.

We're still lacking a generalized newbie tutorial, but perhaps we can add that later (or link to existing tutorials in the README).

benmoran56 avatar Oct 23 '22 04:10 benmoran56