Skip to content

Wrong link to PEPs source file when the file ends in .rst #431

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.

Sign up for GitHub

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

Jump to bottom
Closed
Naereen opened this issue Oct 18, 2017 · 7 comments
Closed

Wrong link to PEPs source file when the file ends in .rst #431

Naereen opened this issue Oct 18, 2017 · 7 comments

Comments

@Naereen
Copy link
Contributor

Naereen commented Oct 18, 2017 •
edited
Loading

Hi,
The issue is simple: the peps pages (eg pep-0553) include a link to the text source file, hosted on GitHub.
But the link points to non-existing .txt files, as some of them are stored as .rst !
The issue comes from the current template:

peps/pep-html-template

Line 24 in 86c06a7

[<b><a href="%(pephome)s/pep-%(pepnum)s.txt">PEP Source</a></b>]

Naereen added a commit to Naereen/peps that referenced this issue Oct 18, 2017
@Naereen
Update pep-html-template
c560061 
Fixing links to PEPs sources from .txt to .rst (see python#431)
@Naereen Naereen mentioned this issue Oct 18, 2017
Closed
@Naereen
Copy link
Contributor Author

Naereen commented Oct 18, 2017

#432 fixes this.
(I don't see a reason this could be a bad idea, please someone review)

@Naereen
Copy link
Contributor Author

Naereen commented Oct 18, 2017

OK I just saw that half the PEPs are stored as txt and half are stored in rst...
So my fix is stupid, but something should be fixed.

@Naereen Naereen changed the title Wrong link to PEPs source .txt file on GitHub : they are .rst ! Wrong link to PEPs source .txt file on GitHub : some are .rst ! Oct 18, 2017
@brettcannon
Copy link
Member

It's a known issue that's waiting for #4 to be completed.

@brettcannon brettcannon changed the title Wrong link to PEPs source .txt file on GitHub : some are .rst ! Wrong link to PEPs source file when the file ends in .rst Oct 18, 2017
@Naereen
Copy link
Contributor Author

Naereen commented Oct 18, 2017

OK, thanks.

Mariatta added a commit to Mariatta/pythondotorg that referenced this issue Nov 15, 2017
@Mariatta
Link to the correct PEP source file.
f69a871 
Some PEPs are using the .rst extension, and many are in .txt.
The source link currently assumes that all the PEPs are using
the .txt extension.

Fixes python/peps#431
@Mariatta Mariatta mentioned this issue Nov 15, 2017
Merged
@Mariatta
Copy link
Member

This PR should take care of it: python/pythondotorg#1195.

Mariatta added a commit to Mariatta/pythondotorg that referenced this issue Nov 15, 2017
@Mariatta
Use single quotes and shorten PEP 12's content.
80e130e 
Fixes python/peps#431
@Naereen
Copy link
Contributor Author

Naereen commented Nov 15, 2017

@Mariatta thanks! That's a fix on the website part, and I would be in favor of accepting it asap (maybe even in a more generic way, cf. my review/comment).

As @brettcannon pointed it out, the important changes to be made are #4, known from a long time.

@Mariatta
Copy link
Member

Thanks @Naereen :)
Issue #4 has been completed, the content of the PEPs have all been converted to restructured text format.
I think the consensus for now is to not rename the files from .txt to .rst since GitHub won't properly display the complete file history after the rename. See the discussion.

Mariatta added a commit to python/pythondotorg that referenced this issue Nov 15, 2017
@Mariatta
Link to the correct PEP source file. (GH-1195)
b89f75f 
Some PEPs are using the .rst extension, and many are in .txt.
The source link assumed that all the PEPs are using
the .txt extension. With this change, it will use the correct file extension.

Fixes python/peps#431
berkerpeksag pushed a commit to python/pythondotorg that referenced this issue Nov 15, 2017
@Mariatta @berkerpeksag
Link to the correct PEP source file. (GH-1195)
9235355 
Some PEPs are using the .rst extension, and many are in .txt.
The source link assumed that all the PEPs are using
the .txt extension. With this change, it will use the correct file extension.

Fixes python/peps#431
@mozillazg mozillazg mentioned this issue Apr 9, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@brettcannon @Mariatta @Naereen