search

benmoran56 / esper

An ECS (Entity Component System) for Python
MIT License
544 stars 69 forks source link

Rewrite Readme, docstrings, and create documentation. #33

Closed anaselmi closed 1 year ago

anaselmi commented 6 years ago

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.

jonathanabennett commented 5 years ago

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

benmoran56 commented 4 years ago

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

MrDowntempo commented 3 years ago

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.

benmoran56 commented 1 year ago

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).