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

Finish documentation #60

Open
paquettg opened this issue Feb 16, 2015 · 6 comments
Open

Finish documentation #60

paquettg opened this issue Feb 16, 2015 · 6 comments

Comments

@paquettg
Copy link
Owner

I would like to finish the documentation on the README to cover the remaining end points that have little/no documentation.

This is primary a self note.

@KioCoan
Copy link

KioCoan commented Jun 21, 2015

Could the next one be the League class? I'm kinda lost trying to get a player's league information.

@ghost
Copy link

ghost commented Sep 30, 2015

I'll see what I can do. Considering I'm trying to make the most of using this repo for my League network, I'll try to help with the documentation. At first I got confused about the stat() method until I went to the API folder, so it's definitely needed.

@paquettg
Copy link
Owner Author

Any effort for documentation is welcomed @MRXXIV . I tried my best to document all the methods as best as I could but. some help on this tedious (but very important) task is appricated

@ghost
Copy link

ghost commented Sep 30, 2015

@paquettg no doubt. I'm grasping a huge understanding of the framework the more I use it and I'll be able to throw some extra details aside from what's already portioned in the current doc version.

I'm sure some people haven't noticed the raw() method yet and it's highly useful.

I might consider building a wiki for the repo instead of simply using the README as the information will get way too crowded eventually. But I already forked a basic league() documentation, so I'll pull a request just for this and I'll work on pages.

@StudioNameHere
Copy link

Maybe you should use the repo wiki.. The Readme is kinda long.

@dnlbauer
Copy link
Collaborator

I agree with @PremadeGames. Unfortunatly I cant find time to work on the docs right now. Pull requests are welcome! :)

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