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

Rewrite Readme, docstrings, and create documentation. #33

Closed
anaselmi opened this issue Jun 22, 2018 · 4 comments
Closed

Rewrite Readme, docstrings, and create documentation. #33

anaselmi opened this issue Jun 22, 2018 · 4 comments

Comments

@anaselmi
Copy link
Contributor

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
Copy link

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
Copy link
Owner

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

@MrDowntempo
Copy link

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
Copy link
Owner

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

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

No branches or pull requests

4 participants