Tweak parameter names for fcntl module

[brettcannon]

BPO	22832
Nosy	@brettcannon, @bitdancer, @berkerpeksag, @vadmium, @serhiy-storchaka, @ashkop
Files	issue22832.patch issue22832_v2.patch issue22832_v3.patch

^{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 = 'https://github.com/serhiy-storchaka'
closed_at = <Date 2015-03-20.18:19:55.967>
created_at = <Date 2014-11-10.01:32:31.240>
labels = ['easy', 'type-feature', 'docs']
title = 'Tweak parameter names for fcntl module'
updated_at = <Date 2015-03-22.10:33:19.049>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2015-03-22.10:33:19.049>
actor = 'martin.panter'
assignee = 'serhiy.storchaka'
closed = True
closed_date = <Date 2015-03-20.18:19:55.967>
closer = 'serhiy.storchaka'
components = ['Documentation']
creation = <Date 2014-11-10.01:32:31.240>
creator = 'brett.cannon'
dependencies = []
files = ['38257', '38295', '38598']
hgrepos = []
issue_num = 22832
keywords = ['patch', 'easy']
message_count = 15.0
messages = ['230931', '236733', '236749', '236760', '236767', '236775', '237024', '238646', '238703', '238706', '238707', '238736', '238747', '238762', '238891']
nosy_count = 8.0
nosy_names = ['brett.cannon', 'r.david.murray', 'docs@python', 'python-dev', 'berker.peksag', 'martin.panter', 'serhiy.storchaka', 'ashkop']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'commit review'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue22832'
versions = ['Python 3.5']

[brettcannon]

http://bugs.python.org/review/20152/ is filled with various suggestions from Serhiy on how to update the function parameters in the fcntl module to more closely match what is in the man pages. This should be fully backwards-compatible as the parameters are positional-only. It should be easy as the code doesn't need to change thanks to Argument Clinic. Trick will be updating both the code and the docs.

[ashkop]

Created a patch. It renames arguments in clinic declarations and in documents. For lockf I've chosen Linux naming, because it really calls fcntl which has an argument called cmd, not function.

[brettcannon]

The patch LGTM. Serhiy, you have anything to add?

[serhiy-storchaka]

I found a lot of not related issues in the documentation.

[ashkop]

Looks like default value for mutate_flag in ioctl() should be False. Docstring says:

"If the argument is a mutable buffer and the mutable_flag argument is not
passed or is false, the behavior is as if a string had been passed."

Should I change the default value or the docstring?

[ashkop]

Docs say that mutate_flag is true by default since Python 2.5. Looks like I should fix the docstring.

[ashkop]

This patch fixes pointed out bugs in documentation and docstring for ioctl() function.

[ashkop]

Fixed default values for fcntl(), ioctl() and lockf()

[serhiy-storchaka]

Except brackets the patch LGTM.