[issue18985] Improve the documentation in fcntl module

[R. David Murray]

R. David Murray added the comment:

Thanks, Vajrasky (and Victor :)

--
resolution:  -> fixed
stage: patch review -> committed/rejected
status: open -> closed

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[Roundup Robot]

Roundup Robot added the comment:

New changeset 0e0dded5d616 by R David Murray in branch '3.3':
#18985: Improve fcntl documentation.
http://hg.python.org/cpython/rev/0e0dded5d616

New changeset ddf6da99b3cd by R David Murray in branch 'default':
Merge #18985: Improve fcntl documentation.
http://hg.python.org/cpython/rev/ddf6da99b3cd

New changeset 645aa4f44aa4 by R David Murray in branch '2.7':
backport #18985: Improve fcntl documentation.
http://hg.python.org/cpython/rev/645aa4f44aa4

--
nosy: +python-dev

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[Vajrasky Kok]

Vajrasky Kok added the comment:

Except for the typo noticed by Victor, your patch looks good.

--

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[R. David Murray]

R. David Murray added the comment:

Vajrasky: what do you think of my version?  Is it clear enough?

I wonder if we want to document the constants someday.

--
stage:  -> patch review
versions: +Python 2.7, Python 3.3

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[R. David Murray]

R. David Murray added the comment:

Here's my suggestion.

--
Added file: http://bugs.python.org/file32442/fcntl-doc.patch

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[Ezio Melotti]

Changes by Ezio Melotti :


--
nosy: +r.david.murray

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[Vajrasky Kok]

Vajrasky Kok added the comment:

Updated patch based on Ezio's review. I reverted back the changes to Nul and 
module documentation (since it is not so clear whether we should categorize 
flock as Unix routine or not).

--
Added file: 
http://bugs.python.org/file31795/fix_documentation_on_fcntl_module_v2.patch

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[Ezio Melotti]

Changes by Ezio Melotti :


--
nosy: +ezio.melotti

___
Python tracker 

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

[issue18985] Improve the documentation in fcntl module

[Vajrasky Kok]

New submission from Vajrasky Kok:

The attached patch fixed typos and improved the documentation to improve the 
clarity in Modules/fcntlmodule.c.

Please see the attached patch and feel free to disagree with the improvement.

--
assignee: docs@python
components: Documentation
files: fix_documentation_on_fcntl_module.patch
keywords: patch
messages: 197358
nosy: docs@python, vajrasky
priority: normal
severity: normal
status: open
title: Improve the documentation in fcntl module
type: enhancement
versions: Python 3.4
Added file: 
http://bugs.python.org/file31695/fix_documentation_on_fcntl_module.patch

___
Python tracker 

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