[issue23320] devguide should mention rules about "paragraph reflow" in the documentation

[Brett Cannon]

Brett Cannon added the comment:

Moved to https://github.com/python/devguide/issues/12

--
nosy: +brett.cannon
resolution:  -> out of date
status: open -> closed

___
Python tracker 

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[Carol Willing]

Carol Willing added the comment:

https://bugs.python.org/issue18041 also provides related insights. Ideally, a 
patch for this issue should address and close both issues.

--
nosy: +willingc

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[Ezio Melotti]

Ezio Melotti added the comment:

Agreed with what Georg said and I think the devguide can be update accordingly.

--
assignee:  - docs@python
components: +Documentation
keywords: +easy
nosy: +docs@python
stage:  - needs patch

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[Terry J. Reedy]

Terry J. Reedy added the comment:

For normal paragraphs, long and short lines make no difference to Sphinx and 
subsequent output.  I would like to know and have documented when (how uneven 
the lines) a reflow is otherwise considered necessary.

--
nosy: +georg.brandl, terry.reedy

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[Georg Brandl]

Georg Brandl added the comment:

For patches to be reviewed (whether submitted by a core developer or not), 
there should be as little spurious changes as possible.  In the final commit, 
it's ok, but not mandatory, to reflow the paragraphs.

--

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[R. David Murray]

R. David Murray added the comment:

That wording is a bit strong :).

On that issue I requested a patch without the reflow, because I prefer that.  
Personally, I think it is in fact worth noting in the devguide that it is 
better for doc patches to not reflow paragraphs so that it is easier to see 
just the changed text in the patch file and in the 'hg diff' output.

However, since reitveld can handle reflowed paragraphs, other developers my not 
agree with me on this.

--
nosy: +r.david.murray

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[Martin Panter]

Changes by Martin Panter vadmium...@gmail.com:


--
nosy: +vadmium

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

[issue23320] devguide should mention rules about paragraph reflow in the documentation

[Akira Li]

New submission from Akira Li:

It is suggested in https://bugs.python.org/issue23251
that only a core Python developer may reflow paragraphs
while submitting patches for the Python documentation.

It should be codified in devguide: I haven't found the
word *reflow* in it.

--
components: Devguide
messages: 234692
nosy: akira, ezio.melotti
priority: normal
severity: normal
status: open
title: devguide should mention rules about paragraph reflow in the 
documentation
type: behavior

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