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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #30

Open
GochoMugo opened this issue Oct 6, 2014 · 5 comments
Open

Documentation #30

GochoMugo opened this issue Oct 6, 2014 · 5 comments

Comments

@GochoMugo
Copy link

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.

馃憤 though cause this module is what we really need!

@lucjon
Copy link
Owner

lucjon commented Oct 6, 2014

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.

@GochoMugo
Copy link
Author

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

@GokulRG
Copy link

GokulRG commented Oct 31, 2016

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?!

@Moshiii
Copy link

Moshiii commented Apr 29, 2020

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

Moshiii commented Apr 29, 2020

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.

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

No branches or pull requests

4 participants