[issue13716] distutils doc contains lots of XXX

[Éric Araujo]

Éric Araujo  added the comment:

Done.

--
resolution:  -> fixed
stage: needs patch -> committed/rejected
status: open -> closed
type: behavior -> enhancement

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Roundup Robot]

Roundup Robot  added the comment:

New changeset e853ea9efc6e by Éric Araujo in branch '2.7':
Hide or remove user-visible XXX notes from distutils doc (#13716).
http://hg.python.org/cpython/rev/e853ea9efc6e

--

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Roundup Robot]

Roundup Robot  added the comment:

New changeset 3d25869fce0c by Éric Araujo in branch '3.2':
Hide or remove user-visible XXX notes from distutils doc (#13716).
http://hg.python.org/cpython/rev/3d25869fce0c

New changeset 1cb9b8126534 by Éric Araujo in branch 'default':
Merge edits from 3.2 (#13716, #1040439, #2945, #13770, #6715)
http://hg.python.org/cpython/rev/1cb9b8126534

--
nosy: +python-dev

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Florent Xicluna]

Florent Xicluna  added the comment:

The proposed solution is ok.

It sounds like unfinished documentation when you hit an "XXX".
For the "/dev/" documentation, it's OK, but for the released version, we should 
avoid it.

--

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Georg Brandl]

Georg Brandl  added the comment:

Agreed.

--

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Éric Araujo]

Éric Araujo  added the comment:

These are the XXX:

  XXX true? does ANSI say anything about this?
  XXX defaults to what?
  XXX see also.
  XXX see also.
  XXX see also.
  XXX see also.
  XXX see also.

The first two are questions that can be answered, and when I research them for 
the packaging docs I could also backport the changes to the distutils docs; 
what to do for the other instances is less clear, so just deleting may be 
better than turning them into comments that will never get solved.

--
assignee: docs@python -> eric.araujo

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Georg Brandl]

Georg Brandl  added the comment:

I would make comments out of the XXX, and if a whole section is just that XXX, 
remove the section as well.

--
nosy: +georg.brandl

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Éric Araujo]

Éric Araujo  added the comment:

Tarek ruled that time spent improving the distutils docs was time lost and 
better spent on distutils2.  Accordingly, I only fix clear bugs in the doc but 
don’t improve them in any way.  I’m inclined to close this as wontfix, or I can 
remove the XXX if you’re strongly against them.  (For the packaging docs, I 
will fix them properly.)

--

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Florent Xicluna]

Changes by Florent Xicluna :


--
nosy: +eric.araujo, tarek
versions: +Python 3.2, Python 3.3

___
Python tracker 

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

[issue13716] distutils doc contains lots of XXX

[Florent Xicluna]

New submission from Florent Xicluna :

http://docs.python.org/distutils/apiref.html?highlight=XXX#module-distutils.ccompiler

We find lots of "XXX" and "XXX see also." which give no information.

--
assignee: docs@python
components: Documentation
messages: 150683
nosy: docs@python, flox
priority: normal
severity: normal
stage: needs patch
status: open
title: distutils doc contains lots of XXX
type: behavior
versions: Python 2.7

___
Python tracker 

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