doc: library imaplib a url not available

[chrisxiao]

BPO	42153
Nosy	@gvanrossum, @birkenfeld, @miss-islington, @chrisxiao, @Hitansh159, @Pixmew
PRs	bpo-42153 doc: library imaplib a URL not available #23292 bpo-42153 doc: library imaplib a URL not available #23296 bpo-42153 doc: library imaplib a URL not available #23297 [3.8] bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297) #23310 [3.9] bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297) #23311
Files	python doc1.png

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-11-16.05:05:57.921>
created_at = <Date 2020-10-26.07:59:35.504>
labels = ['3.9', 'docs']
title = 'doc: library imaplib a url not available'
updated_at = <Date 2020-11-16.05:27:09.127>
user = 'https://github.com/chrisxiao'

bugs.python.org fields:

activity = <Date 2020-11-16.05:27:09.127>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-11-16.05:05:57.921>
closer = 'gvanrossum'
components = ['Documentation']
creation = <Date 2020-10-26.07:59:35.504>
creator = 'chrisxiao'
dependencies = []
files = ['49599']
hgrepos = []
issue_num = 42153
keywords = ['patch']
message_count = 18.0
messages = ['379650', '379653', '380259', '380982', '380983', '381000', '381001', '381002', '381003', '381004', '381005', '381009', '381010', '381011', '381066', '381067', '381069', '381071']
nosy_count = 7.0
nosy_names = ['gvanrossum', 'georg.brandl', 'docs@python', 'miss-islington', 'chrisxiao', 'hitansh159', 'Pixmew']
pr_nums = ['23292', '23296', '23297', '23310', '23311']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue42153'
versions = ['Python 3.9']

[chrisxiao]

jump to https://docs.python.org/3/library/imaplib.html#imap4-objects,

in the "See also" text, the url(https://www.washington.edu/imap/) of the University of Washington’s IMAP Information Center is not available.

[hitansh159]

hello,
I am new to python repo,
I would like to contribute here.

I checked the page to told and it is showing that https://www.washington.edu/imap/ is not found.
I tried to find the url to their documentation but I couldn't found one. can you please guide me here

[chrisxiao]

maybe，you can try to contact the webmaster of the University of Washington to get the correct url

[hitansh159]

I contacted them I got to know that the project is discontinued since 2008 and the resources are no more maintained.
they have provided with an github repo and an archive file link

This is the exact reply:
Unfortunately, both UW IMAP and Pine/Alpine development was discontinued back in 2008 and removed from University systems in 2018. A community copy still exists at https://github.com/uw-imap/imap but UW provides no support or resources for it anymore. It looks like some of the information may still be available via the Wayback Machine https://web.archive.org/web/20080323102305/https://www.washington.edu/imap/

Mark Crispin, the lead developer at UW, started a fork of it called Panda IMAP when he was laid off in 2008, but he has unfortunately passed away and that no longer seems to be maintained.

what would you like me to do next ?

[Pixmew]

Should I change the link to new one (not University of Washington’s IMAP Information Center) as it contains so much information about IMAP4.
I could not find any link from University of Washington, So I suggest changing the link all together. I have a link in mind
I can open a PR If you agree.

[hitansh159]

I made changes to rst file and added link that I got from university of Washington do check it. Let me know if any changes, you find it proper. I will submit my PR.
changes in shown in image

[Pixmew]

The link provided gives UW IMAP Server Documentation not In general Documentation Of IMAP

[Pixmew]

As Documentaion of imaplib we should provide information of imap itself

[Pixmew]

Sorry my Bad your version is Good you can submit your PR,If any problem May I submit it please

[birkenfeld]

It doesn't make sense to include the archive link, the documentation it refers to is available in the GitHub repository under docs/.

[Pixmew]

Then I shall remove the archive link

[Pixmew]

The build fails because of "Inline emphasis start-string without end-string." and bash script exists at code 2
can you please Help me.

[Pixmew]

This is what I get:

Run xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest suspicious html
make: Entering directory '/home/runner/work/cpython/cpython/Doc'
make[1]: Entering directory '/home/runner/work/cpython/cpython/Doc'
mkdir -p build
Building NEWS from Misc/NEWS.d with blurb
PATH=./venv/bin:$PATH sphinx-build -b doctest -d build/doctrees -q -W --keep-going -j4 -W . build/doctest
Warning: ../build/NEWS:111: WARNING: Inline emphasis start-string without end-string.
/home/runner/work/cpython/cpython/Lib/socket.py:775: ResourceWarning: unclosed <socket.socket fd=7, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=6, laddr=('10.1.0.4', 39496), raddr=('116.202.254.214', 119)>
self._sock = None
ResourceWarning: Enable tracemalloc to get the object allocation traceback
<doctest default[0]>:1: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
import imp
<doctest default[2]>:1: DeprecationWarning: formatargspec is deprecated since Python 3.5. Use signature and the Signature object directly
formatargspec(*getfullargspec(f))
Makefile:49: recipe for target 'build' failed
make[1]: *** [build] Error 1
make[1]: Leaving directory '/home/runner/work/cpython/cpython/Doc'
Testing of doctests in the sources finished, look at the results in build/doctest/output.txt
Makefile:127: recipe for target 'doctest' failed
make: *** [doctest] Error 1
make: Leaving directory '/home/runner/work/cpython/cpython/Doc'
Error: Process completed with exit code 2.

[Pixmew]

After some research all the problems are fixed

[gvanrossum]

New changeset aa01011 by Yash Shete in branch 'master':
bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297)
aa01011

[gvanrossum]

Closing in anticipation of the backports landing.

[miss-islington]

New changeset 85a8a19 by Miss Islington (bot) in branch '3.8':
bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297)
85a8a19

[miss-islington]

New changeset 7c4d8fa by Miss Islington (bot) in branch '3.9':
bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297)
7c4d8fa