curses inch() and scrbkgd() documentation ommissions

[pjfarleyiii]

BPO	43715
Nosy	@Mariatta, @pjfarleyiii
Files	curses-doc-change.txt: Documentation suggestion for inch() and scrbkgd()

^{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 = None
closed_at = None
created_at = <Date 2021-04-03.19:22:03.162>
labels = ['extension-modules', '3.8', '3.9']
title = 'curses inch() and scrbkgd() documentation ommissions'
updated_at = <Date 2021-04-10.06:22:50.540>
user = 'https://github.com/pjfarleyiii'

bugs.python.org fields:

activity = <Date 2021-04-10.06:22:50.540>
actor = 'pjfarleyiii'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Extension Modules']
creation = <Date 2021-04-03.19:22:03.162>
creator = 'pjfarleyiii'
dependencies = []
files = ['49930']
hgrepos = []
issue_num = 43715
keywords = []
message_count = 3.0
messages = ['390136', '390530', '390697']
nosy_count = 2.0
nosy_names = ['Mariatta', 'pjfarleyiii']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue43715'
versions = ['Python 3.8', 'Python 3.9']

Linked PRs

• gh-87881: Document the result of curses inch() and getbkgd() #152488
• [3.15] gh-87881: Document the result of curses inch() and getbkgd() (GH-152488) #152511
• [3.14] gh-87881: Document the result of curses inch() and getbkgd() (GH-152488) (GH-152511) #152514
• [3.13] gh-87881: Document the result of curses inch() and getbkgd() (GH-152488) (GH-152511) #152515

[pjfarleyiii]

The documentation for the result values of curses functions inch() and scrbkgd() or how to use those result values are omitted entirely. Documentation should at least describe how to use the result values of these functions without necessarily describing the actual format of the results, which do differ depending on the implementation of curses being used.

A suggestion for the documentation change is attached.

A separate issue will be filed questioning the need to shift the pair number result of the curses.pair_number() function in the Windows terminal environment.

[Mariatta]

Thanks for the patch, but I find it difficult to read in plain text. Can you create a pull request with the your suggested changes?

[pjfarleyiii]

Sorry, this was not meant as a patch. I have no experience with git or
pulls and would not know where to start to do as you have asked. The text
I provided was intended as model text for the python documentation
maintainer to type into whatever piece of python is used to describe those
two functions.

If I knew where to pull a source archive or zip and knew the place or
source member where that documentation is stored, I could generate a "diff
-u" style of patch, but that is the limit of my skill in that area.

Peter

On Thu, Apr 8, 2021 at 10:18 AM Mariatta <report@bugs.python.org> wrote:

Mariatta <mariatta@python.org> added the comment:

Thanks for the patch, but I find it difficult to read in plain text. Can
you create a pull request with the your suggested changes?

----------
nosy: +Mariatta

---

Python tracker <report@bugs.python.org>
<https://bugs.python.org/issue43715\>

---