gh-87904: Document curses classes

[serhiy-storchaka]

Add docstrings for the curses.window, curses.error, curses.panel.panel and curses.panel.error classes. Document the panel class and its error exception in curses.panel.rst, using the real lowercase panel name.

• Issue: Clarify public name of curses.window #87904

[read-the-docs-community]

Documentation build overview

📚 cpython-previews | 🛠️ Build #33283298 | 📁 Comparing 09821e0 against main (12add38)

  🔍 Preview build  

29 files changed · ± 29 modified

± Modified

• glossary.html
• py-modindex.html
• c-api/bytes.html
• deprecations/index.html
• extending/extending.html
• faq/gui.html
• library/codecs.html
• library/csv.html
• library/curses.html
• library/curses.panel.html
• and 19 more...

[serhiy-storchaka]

@encukou, are these IDs case-sensitive?

[StanFromIreland]

I think it would be better to preserve them, like we do elsewhere by injecting some anchors:

.. raw:: html

   <!-- Keep the old URL fragments working (see gh-89554) -->
   <span id='thread.lock.acquire'></span>
   <span id='thread.lock.release'></span>
   <span id='thread.lock.locked'></span>

[encukou]

are these IDs case-sensitive?

Yes. (see: nOTES vs Notes)

I think it would be better to preserve them

That can be a separate (docs-wide) decision; this PR can just add these to removed-ids.txt.

[serhiy-storchaka]

Alternative solution -- rename curses.panel.panel to curses.panel.Panel. But then we would perhaps need to also rename curses.window to curses.Window, and this will create much more IDs issues.

[serhiy-storchaka]

I think it is better to resolve such issues on the HTML server side, if possible. Or add a special Sphynx extension.

This PR is needed for #151748.

[StanFromIreland]

I think it is better to resolve such issues on the HTML server side, if possible. Or add a special Sphynx extension.

Server redirects can be added to https://github.com/python/psf-salt/blob/main/salt/docs/config/nginx.docs-redirects.conf. Hugo proposed a Sphinx extension above, it "redirects" by creating files at the locations pointing to the new location.

[hugovk]

Hugo proposed a Sphinx extension above, it "redirects" by creating files at the locations pointing to the new location.

Here: #151656 (comment)

A benefit of using the Sphinx extension is that each branch is self-contained, so also works locally and for third parties (who of course aren't hosting on PSF infra).

[serhiy-storchaka]

In this case, redirection cannot help, we need to add anchors. The question is only whether to add a raw html, invisible no-typesetting declarations, or use custom Sphinx directives from extension. For now, I added a raw html.

[miss-islington-app]

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖

[miss-islington-app]

Sorry, @serhiy-storchaka, I could not cleanly backport this to 3.14 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 560ff8e2021d818555884622f6865f4a0d60756f 3.14

[bedevere-app]

GH-152048 is a backport of this pull request to the 3.15 branch.