gh-152584: Reorganize the curses documentation into topic subsections#152583
Merged
Conversation
Group the module-level functions, window methods and constants by topic instead of presenting them as flat alphabetical lists, following the categories used by the ncurses manual pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Documentation build overview
|
serhiy-storchaka
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
cursesmodule reference presents its API as three large flat lists: 106 module-level functions, 103windowmethods, and 181 constants. The flat ordering makes related calls hard to find — for example the color functions are scattered alphabetically among unrelated ones — and the key-constant table even carried an inline.. XXX this table is far too large!note.This groups the functions, window methods and constants into topic subsections, following the categories used by the ncurses manual pages (initialization, input/output options, attributes, color, terminfo, mouse, and so on). Entries are only moved, not reworded; cross-references are unaffected since they resolve by name.
This is a documentation-only change, so it should skip the news entry.