Skip to content
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

Updated Python's references to be the official docs instead of Dive Into Python. #17353

Closed

Conversation

The-Amoghavarsha
Copy link

Hey there, recently I came across an outdated (old) resource link in the Django documentation, and I had a little discussion about it on the mailing list and the Discord server to replace it with the Python documentation. And I got a positive response from both places.

Kindly check the discussion here - https://groups.google.com/g/django-developers/c/j28iN_WdTRA

As you can see from the image, I've used ripgrep to locate the resource that I wanted to replace, i.e, Dive Into Python. From docs/intro/index.txt, I've replaced Dive Into Python with Python Documentation and from docs/intro/contributing.txt, I've removed Dive Into Python resource, followed by a few words.

I've tested the changes locally using Sphinx, and everything seems to be working fine.

DiveInto

Copy link
Contributor

@nessita nessita left a comment

Choose a reason for hiding this comment

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

Looks good, I added some suggestions.

Thanks for your contribution!

Comment on lines 35 to 36
Python quickly, we recommend `Python documentation`_. If that's not quite your
style, there are many other `books about Python`_.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Python quickly, we recommend `Python documentation`_. If that's not quite your
style, there are many other `books about Python`_.
Python quickly, we recommend referring to the official `Python
documentation`_, which provides comprehensive and authoritative information
about the language, as well as links to other resources such as a list of
`books about Python`_.

Copy link
Author

Choose a reason for hiding this comment

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

I have accepted the suggestion (omitting /3/), thank you :)

Copy link
Contributor

Choose a reason for hiding this comment

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

Hey @The-Amoghavarsha, I don't see my suggestion applied, would you know what happened? Thanks!

Copy link
Author

Choose a reason for hiding this comment

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

Oops, I'm extremely sorry! I thought it was edited already. It seems like it has been edited outside the commit. I think I have to update my branch.

I was also working on few changes which @ngnpope mentioned below.

Copy link
Contributor

Choose a reason for hiding this comment

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

@The-Amoghavarsha I still don't see the changes I suggested, do you think you could incorporate those? Thanks!

docs/intro/index.txt Outdated Show resolved Hide resolved
docs/intro/contributing.txt Show resolved Hide resolved
@nessita nessita changed the title Adding Python documentation link and removing 'Dive Into Python' resource Updated Python's references to be the official docs instead of Dive Into Python. Oct 10, 2023
Omitting `/3/`

Co-authored-by: nessita <124304+nessita@users.noreply.github.com>
@ngnpope
Copy link
Member

ngnpope commented Oct 11, 2023

There are a number of other broken links to Dive Into Python 3 that we could also fix here:

AUTHORS:    Mark Pilgrim for "Dive Into Python" (https://www.diveinto.org/python3/).
docs/intro/contributing.txt:__ https://diveinto.org/python3/table-of-contents.html
docs/intro/contributing.txt:__ https://diveinto.org/python3/unit-testing.html
docs/intro/index.txt:    .. _Dive Into Python: https://diveinto.org/python3/table-of-contents.html
docs/ref/django-admin.txt:.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath
docs/ref/templates/builtins.txt:https://diveinto.org/python3/native-datatypes.html#slicinglists for an
docs/topics/settings.txt:.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath

Fortunately, it looks as though we can replace https://diveinto.prg/python3/ with https://diveintopython3.net/.

Try using Sphinx's linkcheck to verify that the replacements work, e.g.

$ cd docs/
$ make linkcheck

(It may make sense to just do a check of all the links again as I did in #14325. Ideally we'd have added this as an scheduled check via GitHub Actions, but there are some cases which are not handled as we wish, so it requires manual checking.)

@The-Amoghavarsha
Copy link
Author

The-Amoghavarsha commented Oct 11, 2023

There are a number of other broken links to Dive Into Python 3 that we could also fix here:

AUTHORS:    Mark Pilgrim for "Dive Into Python" (https://www.diveinto.org/python3/).
docs/intro/contributing.txt:__ https://diveinto.org/python3/table-of-contents.html
docs/intro/contributing.txt:__ https://diveinto.org/python3/unit-testing.html
docs/intro/index.txt:    .. _Dive Into Python: https://diveinto.org/python3/table-of-contents.html
docs/ref/django-admin.txt:.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath
docs/ref/templates/builtins.txt:https://diveinto.org/python3/native-datatypes.html#slicinglists for an
docs/topics/settings.txt:.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath

Fortunately, it looks as though we can replace https://diveinto.prg/python3/ with https://diveintopython3.net/.

Try using Sphinx's linkcheck to verify that the replacements work, e.g.

$ cd docs/
$ make linkcheck

(It may make sense to just do a check of all the links again as I did in #14325. Ideally we'd have added this as an scheduled check via GitHub Actions, but there are some cases which are not handled as we wish, so it requires manual checking.)

Thanks for the suggestion. I'll look into it. It makes more sense if the book (I've not read the book) is somewhat easy or straight forward for beginners, especially for learning topics mentioned (such as unit testing). Or should we make Python Docs ubiquitous? One good reason to prefer Docs is that it solves the problem of “getting outdated”.

And also, there are some other links which point to the list of Python books (wiki).

@@ -46,7 +46,7 @@ The value of :envvar:`DJANGO_SETTINGS_MODULE` should be in Python path syntax,
e.g. ``mysite.settings``. Note that the settings module should be on the
Python `import search path`_.

.. _import search path: https://diveinto.org/python3/your-first-python-program.html#importsearchpath
.. _import search path: https://docs.python.org/3/library/sys_path_init.html#sys-path-init
Copy link
Member

Choose a reason for hiding this comment

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

This is an incorrect anchor. Also, links to Python's documentation should use :py: directive.

@felixxm
Copy link
Member

felixxm commented Dec 5, 2023

@The-Amoghavarsha Do you have time to keep working on this?

@The-Amoghavarsha
Copy link
Author

@The-Amoghavarsha Do you have time to keep working on this?

Yes.

@felixxm
Copy link
Member

felixxm commented Jan 8, 2024

Closing due to inactivity.

@felixxm felixxm closed this Jan 8, 2024
TobeTek added a commit to TobeTek/django that referenced this pull request Jan 18, 2024
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
TobeTek added a commit to TobeTek/django that referenced this pull request Jan 18, 2024
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
TobeTek added a commit to TobeTek/django that referenced this pull request Jan 19, 2024
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
TobeTek added a commit to TobeTek/django that referenced this pull request Jan 19, 2024
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
TobeTek added a commit to TobeTek/django that referenced this pull request Jan 19, 2024
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
TobeTek added a commit to TobeTek/django that referenced this pull request Jan 20, 2024
Revised Django documentation to highlight the official Python documentation as the primary resource for the language, replacing Dive into Python.
Outdated links for Dive into Python were also updated
Builds on PR django#17353
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants