Complete lack of documentation.

[marcinant]

Is there any chance to get some usage examples?

The only hint I can see is available in 'gh-issues.el'.

Unfortunately it's wrong.

1. there is no 'gh-issues-list' but only an 'gh-issues-issue-list'
2. I corrected this error above but the only thing I get as result is: 'byte-code: JSON readtable error'

How should I configure this library? Where should I provide and store github password and token?

I can run all tests properly. So this library is workable. But is there any real life use case?

[marcinant]

I got one thing to say after 8 hours of reading and analyzing this code: "This is freaking crazy!!!"

[nicferrier]

I worked out how to use issues and I want to contribute to docs. I don't know Sphix (or rst for that matter) but I'm guessing @sigma wants generated info. I guess I'll play.

If we can get the docs to the point where people contribute when they know how to do stuff that would be good.

[sigma]

yep, agreed, lack of documentation is quite complete (probably the only complete thing in that code base :)).
The reasons for that are:

• my availability has gone down to virtually 0
• the whole thing was a gigantic experiment around the viability of eieio, and I'm pretty disappointed by the amount of suffering it generates, so I'm not sure I should push people to use it...
  (bottom line I agree, this is nuts)

Still, some real life use case are https://github.com/defunkt/gist.el and https://github.com/sigma/magit-gh-pulls

[nicferrier]

I totes agree. eieio is annoying. It's all very depressing. This is a somewhat useful lib though.

I will continue to contribute docs when I have the time.

[aspiers]

In principal having OO elisp is great, but since starting to play with gh.el in the last few hours, my experience has been that eieio makes debugging a bit of a nightmare. Maybe I'm just dumb when it comes to understanding macrostep or something.

[sigma]

@aspiers you're absolutely right, it's a nightmare (although to be fair, gh.el itself is partly responsible, and I'm trying to remove a lot of code in the "next" branch). Especially since eieio is not particularly great at maintaining compatibility from version to version right now (so things tend to fail in very obscure ways).
I guess in the long run I still hope that the debuggers will learn enough about eieio to become more useful.

[jakoblind]

One year since last comment here, and the issue is still relevant. I try to figure out how to use this library but the docs are very limited. Where can I enter the oauth credentials? I am confused. Is this project still alive?

[sigma]

@jakoblind well, I would definitely welcome patches to improve the documentation, but I'm not even sure that would address your question as it would be the "developer" kind of documentation most likely (gh.el is not meant to be directly user-facing).
Anyway, gh-auth.el (and gh-oauth.el) is where you'd see that the oauth token is stored in the git configuration property github.oauth-token. But that should be taken care of automatically...

[jakoblind]

I came here trying to figure out how to make magit-gh-pulls work with personal access tokens (https://github.com/settings/tokens). The code is very difficult for me to get into, I might just write what I need myself :) thanks for your help anyway!

[wpcarro]

After some searching, I found this link.

Would this be worth linking to in the Readme?