This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: curses inch() and scrbkgd() documentation ommissions
Type: Stage:
Components: Extension Modules Versions: Python 3.9, Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: Mariatta, pjfarleyiii
Priority: normal Keywords:

Created on 2021-04-03 19:22 by pjfarleyiii, last changed 2022-04-11 14:59 by admin.

Files
File name Uploaded Description Edit
curses-doc-change.txt pjfarleyiii, 2021-04-03 19:22 Documentation suggestion for inch() and scrbkgd()
Messages (3)
msg390136 - (view) Author: Peter J. Farley III (pjfarleyiii) Date: 2021-04-03 19:22
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.
msg390530 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2021-04-08 14:18
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?
msg390697 - (view) Author: Peter J. Farley III (pjfarleyiii) Date: 2021-04-10 06:22
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>
> _______________________________________
>
History
Date User Action Args
2022-04-11 14:59:43adminsetgithub: 87881
2021-04-10 06:22:50pjfarleyiiisetmessages: + msg390697
2021-04-08 14:18:05Mariattasetnosy: + Mariatta
messages: + msg390530
2021-04-03 19:22:03pjfarleyiiicreate