search

paquettg / leaguewrap

League of Legend API wrapper
MIT License
67 stars 28 forks source link

Finish documentation #60

Open paquettg opened 9 years ago

paquettg commented 9 years ago

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 commented 9 years ago

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

ghost commented 9 years ago

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 commented 9 years ago

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 commented 9 years ago

@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 commented 9 years ago

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

dnlbauer commented 9 years ago

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