Eric's "[Docs] Use relative links to documents in the README" Breaks PyPi links about hypatia-engine HOT 3 OPEN

Sorry about that; it honestly never crossed my mind to check the effects on the PyPi page because I rarely ever read them for any project, instead just going right to the GitHub page (or wherever the code is hosted). It would be nice if we had a separate README for PyPi, but I don't think it's worth the effort just for the sake of working, relative links on GitHub which don't suddenly switch branches on the user. So 👍 from me on reverting the commit. I don't mind reverting it myself if you want, but I'd prefer to leave that to you, simply because I think it's more "appropriate" for you to revert the erroneous commit.

from hypatia-engine.

How do you recommend removing, or "reverting" a commit?

On Thu, Nov 12, 2015 at 8:31 PM, Eric James Michael Ritz <
[email protected]> wrote:

Sorry about that; it honestly never crossed my mind to check the effects
on the PyPi page because I rarely ever read them for any project, instead
just going right to the GitHub page (or wherever the code is hosted). It
would be nice if we had a separate README for PyPi, but I don't think it's
worth the effort just for the sake of working, relative links on GitHub
which don't suddenly switch branches on the user. So [image: 👍] from
me on reverting the commit. I don't mind reverting it myself if you want,
but I'd prefer to leave that to you, simply because I think it's more
"appropriate" for you to revert the erroneous commit.

—
Reply to this email directly or view it on GitHub
#124 (comment)
.

from hypatia-engine.

How do you recommend removing, or "reverting" a commit?

For something that's already in a branch that we cannot rebase, e.g. master and develop, I suggest this:

$ git revert --edit -s <hash of the commit>

This will create a commit that reverses the changes of the given commit, also signing-off on it (-s) and giving you a chance to add any information (--edit) about the reason for the reversion. In this case, for example, you could link to this discussion with a simple GitHub-Issue: #124 so that people in the future could see why the revert was necessary.

from hypatia-engine.