bpo-29725: DOC: add text for arraysize in sqlite3.Cursor #947
Conversation
|
@csabella, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @bitdancer and @ghaering to be potential reviewers. |
Doc/library/sqlite3.rst
Outdated
| .. attribute:: arraysize | ||
|
|
||
| This attribute allows you to set the number of rows returned by :meth:`fetchmany`. | ||
| The default value is 1 meaning a single row would be fetched per call. |
There was a problem hiding this comment.
Even though it is used in the preceding attribute description, I think we usually avoid referring to "you". So something more like "This attribute controls the number of rows...". I think there should be a comma after '1' in the second sentence. It also might read better if it was 'which means...will be' instead of 'meaning', but that's debatable :)
There was a problem hiding this comment.
Thank you. You're right, I had used the word 'you' because of the other text in the sqlite3 documentation. Overall, this one seemed much more conversational that the other docs I've read. I added 'read/write' because I wanted to stress that the user is the one that sets the value. I realize that may be obvious to most people, but they had to spell it out for me in the bpo. :-(
There was a problem hiding this comment.
Yeah, our docs aren't fully consistent, especially the older docs. So when we touch them we sometimes update the style...or sometimes we follow the existing style depending on what the updater feels is best. In this case the style appears to be a mix, so I vote for moving it toward our current style.
I was hoping that 'controls' coupled with 'default' would make it clear you could set it, but maybe that isn't enough?
No description provided.