Skip to content

Update gdb & Victor's guide links, and fix voters link ignore #1051

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

Merged
merged 3 commits into from
Feb 11, 2023

Conversation

Dev-satish
Copy link
Contributor

@Dev-satish Dev-satish commented Feb 10, 2023

Fixes #1044

Changes Made

  1. In advanced-tools/gdb.rst there was a broken link under the topic of GDB 7 and later which was named as extending gdb with Python https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html#Python which has now been replaced by the following link https://sourceware.org/gdb/onlinedocs/gdb/Python.html

  2. In conf.py there was a slash at the end of the link https://github.com/python/voters/ which made this link broken and this issue has been resolved by removing the slash from the end of the link https://github.com/python/voters

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One little suggestion.

And please could you edit your PR message at the top here and add in "Fixes #1044"?

Then, when this PR is merged, it will automatically close that issue.

Thank you!

@@ -21,7 +21,7 @@ GDB 7 and later
===============

In gdb 7, support for `extending gdb with Python
<https://sourceware.org/gdb/current/onlinedocs/gdb/Python.html#Python>`_ was
<https://sourceware.org/gdb/onlinedocs/gdb/Python.html#Python>`_ was
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't really need the #Python bit. There is an anchor on the page, but it's right at the top.

Suggested change
<https://sourceware.org/gdb/onlinedocs/gdb/Python.html#Python>`_ was
<https://sourceware.org/gdb/onlinedocs/gdb/Python.html>`_ was

@CAM-Gerlach CAM-Gerlach changed the title gh-1044 fixed conf.py and advanced-tools/gdb.rst links Fix conf.py and advanced-tools/gdb.rst links Feb 10, 2023
@CAM-Gerlach
Copy link
Member

File : conf.py
line changed : 84

File : advanced-tools/gdb.rst
line changed : 24

Just a tip—instead of repeating a summary of the information that can be easily seen in much more detail by clicking the Files Changed tab, it would be much more useful to provide a brief overall summary of your meaningful changes.

And please could you edit your PR message at the top here and add in "Fixes #1044"?

Just FYI, core team members (devs and now triagers) can edit posts, and you can also add it directly under Development in the sidebar. My only hesitation there is that we might not want to close that issue until the relevant information is incorporated into the devguide itself, since this is only a stopgap fix.

@CAM-Gerlach CAM-Gerlach changed the title Fix conf.py and advanced-tools/gdb.rst links Update gdb & Victor's guide links, and fix voters link ignore Feb 10, 2023
@Dev-satish
Copy link
Contributor Author

Dev-satish commented Feb 11, 2023

File : conf.py
line changed : 84

File : advanced-tools/gdb.rst
line changed : 24

Just a tip—instead of repeating a summary of the information that can be easily seen in much more detail by clicking the Files Changed tab, it would be much more useful to provide a brief overall summary of your meaningful changes.

And please could you edit your PR message at the top here and add in "Fixes #1044"?

Just FYI, core team members (devs and now triagers) can edit posts, and you can also add it directly under Development in the sidebar. My only hesitation there is that we might not want to close that issue until the relevant information is incorporated into the devguide itself, since this is only a stopgap fix.

Understood, thanks for the feedback I'll change it right away

@Dev-satish Dev-satish changed the title Update gdb & Victor's guide links, and fix voters link ignore Fixes #1044 Update gdb & Victor's guide links, and fix voters link ignore Feb 11, 2023
@Dev-satish
Copy link
Contributor Author

@CAM-Gerlach, can you check if the documentation is correct ?

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The linkcheck on the CI is all green now: https://github.com/python/devguide/actions/runs/4150295949/jobs/7179852698

Thank you again for your contribution!

@hugovk hugovk changed the title Fixes #1044 Update gdb & Victor's guide links, and fix voters link ignore Update gdb & Victor's guide links, and fix voters link ignore Feb 11, 2023
@hugovk hugovk merged commit 39dcbb7 into python:main Feb 11, 2023
@Dev-satish
Copy link
Contributor Author

The linkcheck on the CI is all green now: https://github.com/python/devguide/actions/runs/4150295949/jobs/7179852698

Thank you again for your contribution!

Thank you so much for giving this opportunity to me! If there are any other similar issues or issues bit higher than this level for me then please let me know as I want to learn further and understand how contribution works. Even resources to contribute in python or tips for future work and learning would be a great asset to me!

@CAM-Gerlach
Copy link
Member

@CAM-Gerlach, can you check if the documentation is correct ?

Assuming you mean your description in the OP, I just meant that to be taken as a helpful tip for the future rather than anything required now, but you did an excellent job!

Aside from simple devguide, docs, etc. fixes like this, IMO one good place to start contributing (and where I started myself in open source originally, before I even knew that much more than a beginner level of Python) is helping triage new issues. If the issue is a bug, try to reproduce it and report your results, or request additional required/clarifying information from the OP if not. If it appears to be a user-side issue, give the user troubleshooting advice and redirect them to a more appropriate forum (e.g. Python Help on the Python Discourse). If its a feature request, ensure it is complete, valid and well-specified, etc. See the devguide pages on triaging for more guidance.

Beyond that, you can also:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Victor Stinner’s guide has broken link in documentation
4 participants