[issue18758] Fix internal references in the documentation

[Georg Brandl]

Georg Brandl added the comment:

Thank you for all the effort you put into this!

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Thank you Georg for all your reviews.

Only patch for pickle left, and this is not trivial one.

--
resolution:  -> fixed
stage: patch review -> committed/rejected

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Roundup Robot]

Roundup Robot added the comment:

New changeset fa7cfbec0d32 by Serhiy Storchaka in branch '2.7':
Issue #18758: Fixed and improved cross-references.
http://hg.python.org/cpython/rev/fa7cfbec0d32

New changeset 907da535ed9d by Serhiy Storchaka in branch '3.3':
Issue #18758: Fixed and improved cross-references.
http://hg.python.org/cpython/rev/907da535ed9d

New changeset 261d9bf0cc2b by Serhiy Storchaka in branch 'default':
Issue #18758: Fixed and improved cross-references.
http://hg.python.org/cpython/rev/261d9bf0cc2b

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

> The -n (nitpicky) option to Sphinx should also report missing references.

Great.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Georg Brandl]

Georg Brandl added the comment:

The -n (nitpicky) option to Sphinx should also report missing references.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Here is a patch to Sphinx which helped me to search dead internal references. 
Not all references were fixed by proposed patches.

--
Added file: http://bugs.python.org/file32061/sphinx_warn_refs.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Georg Brandl]

Georg Brandl added the comment:

OK then -- so much the better.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

No. BytesWarning is related only to bytes and bytearray.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Georg Brandl]

Georg Brandl added the comment:

Looks good, except that buffer doesn't really correspond to bytearray.  No 
memoryview involved there?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

And here is a patch with small changes which doesn't worth separated issue.

--
keywords: +patch
stage:  -> patch review
Added file: http://bugs.python.org/file32019/refs.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in os documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in urllib documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in curses howto

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in cgi documentation, Improve 
cross-references in shlex documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in C API

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in pickle documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in fcntl documentation

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in tutorial

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Improve cross-references in builtins documentation., Improve 
cross-references in pickle documentation.

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Yes. I have 180 Kb patch which touches 107 files, and this is yet too large for 
one issue. I will continue split this patch for lesser issues.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Ezio Melotti]

Ezio Melotti added the comment:

Serhiy, are you planning to work on more patches or can this be closed?

--
type:  -> enhancement

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Georg Brandl]

Georg Brandl added the comment:

Definitely not.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
assignee: docs@python -> serhiy.storchaka

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Ezio Melotti]

Ezio Melotti added the comment:

That's probably not worth it.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Fix internal doc references for the email package

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

In such case perhaps links should be explicitly prohibited (with '!' mark).

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Fix internal doc references for logging package, Fix internal 
doc references for the xml package

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Ezio Melotti]

Ezio Melotti added the comment:

Note that not all the targets should be converted to links.  They should be 
converted only if the link is useful, and usually redundant links are not 
necessary (e.g. if the same target is repeated several times in the same 
paragraph/section).

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

Changes by Serhiy Storchaka :


--
dependencies: +Fix internal references for concurrent modules, References to 
non-existant "StringIO" module

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18758] Fix internal references in the documentation

[Serhiy Storchaka]

New submission from Serhiy Storchaka:

This is a meta issue for fixing broken references in the documentation. I will 
open a child issues for some groups of modules and finally provide a patch for 
rest files.

--
assignee: docs@python
components: Documentation
messages: 195392
nosy: docs@python, eric.araujo, ezio.melotti, georg.brandl, serhiy.storchaka
priority: normal
severity: normal
status: open
title: Fix internal references in the documentation
versions: Python 2.7, Python 3.3, Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com