Replace doc url

[martinqt]

I'm not sure to understand the v3/todo url. Should there be example of a url that returns a commit object (like the current comment would suggest) or the url to the github reference page (in which case I'd like to slightly change the sentance).

IMO, the second solution is better.

I'll update this PR depending on your answer.

PS: thx for this nice library.

[jacquev6]

What I had in mind was to link to the Github API v3 reference (second
solution, replacing only "todo"). But indeed the sentence is misleading.
Feel free to change it. Can you please make links point to the exact part
of the page (with a #anchor)?

I will be completely unavailable during the next 8 days, so I will merge
your work after that.

Thank you for your contribution.
Le 1 juin 2013 12:09, "martinqt" notifications@github.com a écrit :

I'm not sure to understand the v3/todo url. Should there be example of a
url that returns a commit object (like the current comment would suggest)
or the url to the github reference page (in which case I'd like to slightly
change the sentance).

IMO, the second solution is better.

I'll update this PR depending on your answer.

PS: thx for this nice library.

You can merge this Pull Request by running

git pull https://github.com/martinqt/PyGithub doc

Or view, comment on, or merge it at:

#171
Commit Summary

• Replace doc url

File Changes

• M github/Commit.pyhttps://github.com/Replace doc url #171/files#diff-0(2)

Patch Links:

• https://github.com/jacquev6/PyGithub/pull/171.patch
• https://github.com/jacquev6/PyGithub/pull/171.diff

[martinqt]

Thanks for the answer. I'll start updating the others file. For the anchors, in the commit case, I don't see which one (there's only a get and creation section). Must there be an anchor for every link?

edit: what about "This class represents Commits. The reference can be found here (url)" as doc pattern?

[jacquev6]

Thank you for your contribution! I will update http://jacquev6.github.io/PyGithub/ with the new generated doc soon.

[martinqt]

You're welcome but I didn't find some stuff like Plan. Is this legacy or github enterprise stuff?

[jacquev6]

Some simple classes inheriting from NonCompletableGithubObject represent objects never returned alone by Github API v3, but always as parts of bigger objects. Plan, for example is part of User (and maybe part of Organization).

[martinqt]

Ok thanks, I've overlooked some part of github ref to fast then.

[coveralls]

Changes Unknown when pulling ab674df on martinqt:doc into * on jacquev6:develop*.