leaguewrap icon indicating copy to clipboard operation
leaguewrap copied to clipboard

Finish documentation

Open paquettg opened this issue 9 years ago • 6 comments

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.

paquettg avatar Feb 16 '15 18:02 paquettg

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

KioCoan avatar Jun 21 '15 08:06 KioCoan

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.

ghost avatar Sep 30 '15 10:09 ghost

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

paquettg avatar Sep 30 '15 13:09 paquettg

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

ghost avatar Sep 30 '15 13:09 ghost

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

StudioNameHere avatar Oct 20 '15 20:10 StudioNameHere

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

dnlbauer avatar Nov 30 '15 12:11 dnlbauer