Skip to content

Convert Pep 2 rst. #16

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Convert Pep 2 rst. #16

wants to merge 1 commit into from

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Jun 18, 2016

Mostly automatized (still polishing edges of the help script).

The change of indentation of rst and the wrap between 70 and 79 characters looks like a lot of change,
but it's mostly whitespace.

can be seen locally with

git diff origin/master --word-diff --ignore-all-space

@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

Unfortunately we couldn't find an account corresponding
to your GitHub username at bugs.python.org (b.p.o).
If you don't already have an account at b.p.o, please
create one and make sure to
add your GitHub username. If you do already have an account at b.p.o then
please go there and under "Your Details" add your GitHub username.

And in case you haven't already, please make sure to sign the
PSF contributor agreement
(CLA); we can't legally look at your contribution until you have signed the
CLA.

Once you have done everything that's needed, please reply here and someone will
verify everything is in order.

@berkerpeksag
Copy link
Member

Thanks. In addition to what the Knight said, please squash the commits in the pep-2-rst branch.

@Carreau
Copy link
Contributor Author

Carreau commented Jun 19, 2016

GitHub User name update on b.p.o, so Knight will likely change to CLA Signed

please squash the commits in the pep-2-rst branch.

Sure thing. Do you know that GitHub can do that for you when you press the green merge button ?

@Carreau
Copy link
Contributor Author

Carreau commented Jun 19, 2016

Rebased and force pushed.

@berkerpeksag
Copy link
Member

Do you know that GitHub can do that for you when you press the green merge button ?

Yes, I know but we don't always have a chance to do all the review and testing steps via GitHub UI (in this case we need to pull the branch locally and build the HTML version of the file) so it would be nice to avoid the rebasing step as a reviewer :)

@Carreau
Copy link
Contributor Author

Carreau commented Jun 19, 2016

Yes, I know but we don't always have a chance to do all the review and testing steps via GitHub UI (in this case we need to pull the branch locally and build the HTML version of the file) so it would be nice to avoid the rebasing step as a reviewer :)

Fair enough :-)

@birkenfeld
Copy link
Member

Even in RST format, PEPs are supposed to be wrapped at 70 chars.

42b38c5 Fix indentation to 4 space.
5962011 Auto convert pep-0002 to rst
6fcce5d Manual fixes to pep 0002
@Carreau
Copy link
Contributor Author

Carreau commented Jun 19, 2016

Even in RST format, PEPs are supposed to be wrapped at 70 chars.

Sorry I missunderstood the 70char/79char statement in the pep.
rewrapped at 70.

@Carreau
Copy link
Contributor Author

Carreau commented Jun 19, 2016

in this case we need to pull the branch locally and build the HTML version of the file; so it would be nice to avoid the rebasing step as a reviewer

See auto generated version here :

https://carreau.github.io/peps/render-pep-2-rst/pep-0002.html

Also Tip:

$ cat ~/.gitconfig
<snip>
[remote "origin"]
    fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
<snip>

and you can now do :

$ git fetch 
<snip>
$ git checkout origin/pr/<number>

@berkerpeksag
Copy link
Member

Merged in cce5754, thanks! Already have an alias set for that command.

@Carreau Carreau deleted the pep-2-rst branch June 19, 2016 19:40
This was referenced Jun 19, 2016
@brettcannon
Copy link
Member

Just a quick thing for @berkerpeksag : don't worry about squashing commits for PEPs. No one really reads the commit history for PEPs regularly for any critical reason and so it's more important to make our lives easier to accept PRs than it is to keep a clean commit history.

@berkerpeksag
Copy link
Member

That argument doesn't really justify having commits like "fix", "typo", "f* bash" in an official Python repository.

@Carreau
Copy link
Contributor Author

Carreau commented Jun 20, 2016

Oops, that I usually rebased /ammend after I test. Agree that commit
messages should be cleaned. Sorry if I missed one.
On Jun 20, 2016 10:35, "Berker Peksag" [email protected] wrote:

That argument doesn't really justify having commits like "fix", "typo",
"f* bash" in an official Python repository.


You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#16 (comment), or mute
the thread
https://github.com/notifications/unsubscribe/AAUez8KHamQ0rTh9wS0qY5DUJHpK4-hnks5qNs98gaJpZM4I5De9
.

lukpueh pushed a commit to lukpueh/peps that referenced this pull request Oct 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants