-
-
Notifications
You must be signed in to change notification settings - Fork 844
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
Conversation
There was a problem hiding this 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!
advanced-tools/gdb.rst
Outdated
@@ -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 |
There was a problem hiding this comment.
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.
<https://sourceware.org/gdb/onlinedocs/gdb/Python.html#Python>`_ was | |
<https://sourceware.org/gdb/onlinedocs/gdb/Python.html>`_ was |
Just a tip—instead of repeating a summary of the information that can be easily seen in much more detail by clicking the
Just FYI, core team members (devs and now triagers) can edit posts, and you can also add it directly under |
Understood, thanks for the feedback I'll change it right away |
@CAM-Gerlach, can you check if the documentation is correct ? |
There was a problem hiding this 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!
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! |
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:
|
Fixes #1044
Changes Made
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 Pythonhttps://sourceware.org/gdb/current/onlinedocs/gdb/Python.html#Python
which has now been replaced by the following linkhttps://sourceware.org/gdb/onlinedocs/gdb/Python.html
In
conf.py
there was a slash at the end of the linkhttps://github.com/python/voters/
which made this link broken and this issue has been resolved by removing the slash from the end of the linkhttps://github.com/python/voters