Py-StackExchange icon indicating copy to clipboard operation
Py-StackExchange copied to clipboard

Documentation

Open GochoMugo opened this issue 10 years ago • 5 comments

This Implementation is Awesome and Simple!

However I would not (really x10) mind better documentation. Especially when it comes to what parameters are being expected for method calls.

:+1: though cause this module is what we really need!

GochoMugo avatar Oct 06 '14 14:10 GochoMugo

Thanks for raising this as an issue. I'm aware the documentation isn't really up to scratch, and I'll see what I can do towards improving that.

In the meantime, the names of the method calls and the parameters they expect are almost always very close to those listed on the Stack Exchange site (http://api.stackexchange.com/docs/), and if you have any particular queries, feel free to contact me either on StackApps or by e-mail.

lucjon avatar Oct 06 '14 16:10 lucjon

I am dropping you an email, we discuss this same issue further

GochoMugo avatar Oct 07 '14 16:10 GochoMugo

Same issue.. Documentation conveys zero information. For example in a program you have used a parameter so.questions(sort = Sort.Votes, order=DESC) . How does this work? This Sort only accepts that argument.. What if i need to sort the users based on their badge_count. How do I do that?!

GokulRG avatar Oct 31 '16 04:10 GokulRG

Hi guys,

I think this Site.py is the file you nee to look at for methods parameters: https://github.com/lucjon/Py-StackExchange/blob/master/stackexchange/site.py

it says pretty clear what methods are available for Site Class and what parameters it takes.

Read the source code.

Moshiii avatar Apr 29 '20 12:04 Moshiii

Same issue.. Documentation conveys zero information. For example in a program you have used a parameter so.questions(sort = Sort.Votes, order=DESC) . How does this work? This Sort only accepts that argument.. What if i need to sort the users based on their badge_count. How do I do that?!

try:

print(Sort.__dict__)

to see all attributes in Sort.

Moshiii avatar Apr 29 '20 12:04 Moshiii