Ask GitHub to provide an option to not render .rst files
Hey all, If you've ever tried to inspect a file on github with the `.rst` extension, there's a good chance that you were frustrated by GitHub providing a rendered view *only* of the file, with no option to view the source code like any other text file. It is certainly nice to have a rendered view, but often I want to inspect the actual source code (e.g. to find out at which line a heading occurs, perhaps to include a link to it in a pull request). There is the "raw" option, or you could click "edit", but what is really desired is a view of the source like any other source code. Files with the `.md` extension are also rendered by default, but there are buttons that allow you to either "Display the source blob" or "Display the rendered blob". There is no such option for `.rst` files. If they can do it for `.md` files, it seems like it should be easy to do the same for `.rst` files. I've tried creating a ticket on github about this, but it seems like tickets go to the wrong group. The response I got was from the "GitHub Support" team, and they said they forwarded the request to the "Product" team. (It's all GitHub to me.) It was also suggested that I bring this up in a public feedback discussions, so I did: https://github.com/github/feedback/discussions/7999 If you have a moment, could you add a comment, or click the upvote button, or add some other feedback to the discussion? It would be nice to get this simple enhancement into the GitHub site. Thanks, Warren
+1 for the request. In workarounds for this nor previously mentioned, there is also: - The Refined Github browser extension, which adds that button for .md/.rst. Exemple: https://user-images.githubusercontent.com/1402241/54814836-7bc39c80-4ccb-11e... - another workaround is to click on the "blame" button -- Roman On 22/11/2021 18:38, Warren Weckesser wrote:
Hey all,
If you've ever tried to inspect a file on github with the `.rst` extension, there's a good chance that you were frustrated by GitHub providing a rendered view *only* of the file, with no option to view the source code like any other text file. It is certainly nice to have a rendered view, but often I want to inspect the actual source code (e.g. to find out at which line a heading occurs, perhaps to include a link to it in a pull request). There is the "raw" option, or you could click "edit", but what is really desired is a view of the source like any other source code.
Files with the `.md` extension are also rendered by default, but there are buttons that allow you to either "Display the source blob" or "Display the rendered blob". There is no such option for `.rst` files. If they can do it for `.md` files, it seems like it should be easy to do the same for `.rst` files.
I've tried creating a ticket on github about this, but it seems like tickets go to the wrong group. The response I got was from the "GitHub Support" team, and they said they forwarded the request to the "Product" team. (It's all GitHub to me.) It was also suggested that I bring this up in a public feedback discussions, so I did:
https://github.com/github/feedback/discussions/7999
If you have a moment, could you add a comment, or click the upvote button, or add some other feedback to the discussion? It would be nice to get this simple enhancement into the GitHub site.
Thanks,
Warren _______________________________________________ SciPy-Dev mailing list -- scipy-dev@python.org To unsubscribe send an email to scipy-dev-leave@python.org https://mail.python.org/mailman3/lists/scipy-dev.python.org/ Member address: rth.yurchak@gmail.com
Hi Warren, I upvoted as well :) I also have another trick to add. Click on the key “.” to open the repo in an online VSCode window. Cheers, Pamphile
On 22.11.2021, at 18:50, Roman Yurchak <rth.yurchak@gmail.com> wrote:
+1 for the request.
In workarounds for this nor previously mentioned, there is also: - The Refined Github browser extension, which adds that button for .md/.rst. Exemple: https://user-images.githubusercontent.com/1402241/54814836-7bc39c80-4ccb-11e... - another workaround is to click on the "blame" button
-- Roman On 22/11/2021 18:38, Warren Weckesser wrote:
Hey all, If you've ever tried to inspect a file on github with the `.rst` extension, there's a good chance that you were frustrated by GitHub providing a rendered view *only* of the file, with no option to view the source code like any other text file. It is certainly nice to have a rendered view, but often I want to inspect the actual source code (e.g. to find out at which line a heading occurs, perhaps to include a link to it in a pull request). There is the "raw" option, or you could click "edit", but what is really desired is a view of the source like any other source code. Files with the `.md` extension are also rendered by default, but there are buttons that allow you to either "Display the source blob" or "Display the rendered blob". There is no such option for `.rst` files. If they can do it for `.md` files, it seems like it should be easy to do the same for `.rst` files. I've tried creating a ticket on github about this, but it seems like tickets go to the wrong group. The response I got was from the "GitHub Support" team, and they said they forwarded the request to the "Product" team. (It's all GitHub to me.) It was also suggested that I bring this up in a public feedback discussions, so I did: https://github.com/github/feedback/discussions/7999 If you have a moment, could you add a comment, or click the upvote button, or add some other feedback to the discussion? It would be nice to get this simple enhancement into the GitHub site. Thanks, Warren _______________________________________________ SciPy-Dev mailing list -- scipy-dev@python.org To unsubscribe send an email to scipy-dev-leave@python.org https://mail.python.org/mailman3/lists/scipy-dev.python.org/ Member address: rth.yurchak@gmail.com
SciPy-Dev mailing list -- scipy-dev@python.org To unsubscribe send an email to scipy-dev-leave@python.org https://mail.python.org/mailman3/lists/scipy-dev.python.org/ Member address: roy.pamphile@gmail.com
On 11/22/21 9:38 AM, Warren Weckesser wrote:
Hey all,
If you've ever tried to inspect a file on github with the `.rst` extension, there's a good chance that you were frustrated by GitHub providing a rendered view *only* of the file, with no option to view the source code like any other text file. It is certainly nice to have a rendered view, but often I want to inspect the actual source code (e.g. to find out at which line a heading occurs, perhaps to include a link to it in a pull request). There is the "raw" option, or you could click "edit", but what is really desired is a view of the source like any other source code.
If `?plain=1` is appended to the url Github displays the source. It'd be nice to have a UI element to control that though. Cheers, Gavin *snip*
participants (4)
-
Gavin Price
-
Pamphile Roy
-
Roman Yurchak
-
Warren Weckesser