GeezerVison is showing github.com — gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules by hugovk · Pull Request #103457 · python/cpython
Conversation
hugovk
commented
Apr 11, 2023
•
edited by bedevere-bot
Loading
Uh oh!
There was an error while loading. Please reload this page.
Fix 118 nit-picky warnings in Doc/howto/curses.rst, Doc/library/curses.rst and Doc/library/curses.ascii.rst.
There are still a few remaining warnings I wasn't sure about, so they've not yet been removed from .nitignore, but it reduces 130 -> 12 warnings.
Before
❯ touch Doc/howto/curses.rst Doc/library/curses*; make -C Doc html SPHINXERRORHANDLING=-n 2>&1 | grep "curses.*WARNING" | tee >(wc -l)
Doc/howto/curses.rst:64: WARNING: c:func reference target not found: addstr
Doc/howto/curses.rst:64: WARNING: c:func reference target not found: mvaddstr
Doc/howto/curses.rst:64: WARNING: c:func reference target not found: mvwaddstr
Doc/howto/curses.rst:81: WARNING: py:func reference target not found: initscr
Doc/howto/curses.rst:105: WARNING: py:const reference target not found: curses.KEY_LEFT
Doc/howto/curses.rst:152: WARNING: py:func reference target not found: wrapper
Doc/howto/curses.rst:152: WARNING: py:func reference target not found: wrapper
Doc/howto/curses.rst:189: WARNING: py:data reference target not found: curses.LINES
Doc/howto/curses.rst:189: WARNING: py:data reference target not found: curses.COLS
Doc/howto/curses.rst:199: WARNING: py:meth reference target not found: refresh
Doc/howto/curses.rst:208: WARNING: py:meth reference target not found: refresh
Doc/howto/curses.rst:237: WARNING: py:meth reference target not found: refresh
Doc/howto/curses.rst:243: WARNING: py:meth reference target not found: refresh
Doc/howto/curses.rst:254: WARNING: py:meth reference target not found: noutrefresh
Doc/howto/curses.rst:254: WARNING: py:func reference target not found: doupdate
Doc/howto/curses.rst:262: WARNING: c:func reference target not found: addstr
Doc/howto/curses.rst:262: WARNING: c:func reference target not found: mvaddstr
Doc/howto/curses.rst:262: WARNING: c:func reference target not found: waddstr
Doc/howto/curses.rst:262: WARNING: c:func reference target not found: addstr
Doc/howto/curses.rst:262: WARNING: c:func reference target not found: mvwaddstr
Doc/howto/curses.rst:298: WARNING: py:attr reference target not found: encoding
Doc/howto/curses.rst:307: WARNING: py:const reference target not found: ACS_PLMINUS
Doc/howto/curses.rst:307: WARNING: py:const reference target not found: ACS_ULCORNER
Doc/howto/curses.rst:348: WARNING: py:const reference target not found: A_BLINK
Doc/howto/curses.rst:350: WARNING: py:const reference target not found: A_BOLD
Doc/howto/curses.rst:352: WARNING: py:const reference target not found: A_DIM
Doc/howto/curses.rst:354: WARNING: py:const reference target not found: A_REVERSE
Doc/howto/curses.rst:356: WARNING: py:const reference target not found: A_STANDOUT
Doc/howto/curses.rst:358: WARNING: py:const reference target not found: A_UNDERLINE
Doc/howto/curses.rst:381: WARNING: py:const reference target not found: A_REVERSE
Doc/howto/curses.rst:398: WARNING: py:func reference target not found: start_color
Doc/howto/curses.rst:398: WARNING: py:const reference target not found: curses.COLOR_BLACK
Doc/howto/curses.rst:398: WARNING: py:const reference target not found: curses.COLOR_RED
Doc/howto/curses.rst:445: WARNING: py:meth reference target not found: getch
Doc/howto/curses.rst:445: WARNING: py:meth reference target not found: getkey
Doc/howto/curses.rst:445: WARNING: py:meth reference target not found: getch
Doc/howto/curses.rst:445: WARNING: py:meth reference target not found: getkey
Doc/howto/curses.rst:445: WARNING: py:meth reference target not found: getch
Doc/howto/curses.rst:455: WARNING: py:meth reference target not found: getch
Doc/howto/curses.rst:455: WARNING: py:const reference target not found: curses.KEY_PPAGE
Doc/howto/curses.rst:455: WARNING: py:const reference target not found: curses.KEY_HOME
Doc/howto/curses.rst:455: WARNING: py:const reference target not found: curses.KEY_LEFT
Doc/howto/curses.rst:524: WARNING: py:const reference target not found: ACS_*
Doc/library/curses.rst:62: WARNING: py:const reference target not found: A_NORMAL
Doc/library/curses.rst:107: WARNING: py:const reference target not found: A_STANDOUT
Doc/library/curses.rst:107: WARNING: py:const reference target not found: A_REVERSE
Doc/library/curses.rst:107: WARNING: py:const reference target not found: A_*
Doc/library/curses.rst:179: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:202: WARNING: py:const reference target not found: KEY_MOUSE
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_PRESSED
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_RELEASED
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_CLICKED
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_DOUBLE_CLICKED
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTONn_TRIPLE_CLICKED
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTON_SHIFT
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTON_CTRL
Doc/library/curses.rst:202: WARNING: py:const reference target not found: BUTTON_ALT
Doc/library/curses.rst:226: WARNING: py:func reference target not found: putwin
Doc/library/curses.rst:549: WARNING: 'envvar' reference target not found: TERM
Doc/library/curses.rst:562: WARNING: py:const reference target not found: COLORS
Doc/library/curses.rst:562: WARNING: py:const reference target not found: COLOR_PAIRS
Doc/library/curses.rst:578: WARNING: 'envvar' reference target not found: TERM
Doc/library/curses.rst:644: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:644: WARNING: 'envvar' reference target not found: COLS
Doc/library/curses.rst:662: WARNING: py:const reference target not found: KEY_MOUSE
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNS
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNS
Doc/library/curses.rst:806: WARNING: py:const reference target not found: ACS_VLINE
Doc/library/curses.rst:808: WARNING: py:const reference target not found: ACS_VLINE
Doc/library/curses.rst:810: WARNING: py:const reference target not found: ACS_HLINE
Doc/library/curses.rst:812: WARNING: py:const reference target not found: ACS_HLINE
Doc/library/curses.rst:814: WARNING: py:const reference target not found: ACS_ULCORNER
Doc/library/curses.rst:816: WARNING: py:const reference target not found: ACS_URCORNER
Doc/library/curses.rst:818: WARNING: py:const reference target not found: ACS_LLCORNER
Doc/library/curses.rst:820: WARNING: py:const reference target not found: ACS_LRCORNER
Doc/library/curses.rst:1327: WARNING: py:const reference target not found: __version__
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F1
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F2
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F3
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_F4
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_UP
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_DOWN
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_LEFT
Doc/library/curses.rst:1605: WARNING: py:const reference target not found: KEY_RIGHT
Doc/library/curses.rst:1858: WARNING: py:const reference target not found: KEY_LEFT
Doc/library/curses.rst:1860: WARNING: py:const reference target not found: KEY_RIGHT
Doc/library/curses.rst:1862: WARNING: py:const reference target not found: KEY_UP
Doc/library/curses.rst:1864: WARNING: py:const reference target not found: KEY_DOWN
Doc/library/curses.rst:1866: WARNING: py:const reference target not found: KEY_BACKSPACE
Doc/library/curses.ascii.rst:22: WARNING: py:const reference target not found: NUL
Doc/library/curses.ascii.rst:24: WARNING: py:const reference target not found: SOH
Doc/library/curses.ascii.rst:26: WARNING: py:const reference target not found: STX
Doc/library/curses.ascii.rst:28: WARNING: py:const reference target not found: ETX
Doc/library/curses.ascii.rst:30: WARNING: py:const reference target not found: EOT
Doc/library/curses.ascii.rst:32: WARNING: py:const reference target not found: ENQ
Doc/library/curses.ascii.rst:32: WARNING: py:const reference target not found: ACK
Doc/library/curses.ascii.rst:34: WARNING: py:const reference target not found: ACK
Doc/library/curses.ascii.rst:36: WARNING: py:const reference target not found: BEL
Doc/library/curses.ascii.rst:38: WARNING: py:const reference target not found: BS
Doc/library/curses.ascii.rst:40: WARNING: py:const reference target not found: TAB
Doc/library/curses.ascii.rst:42: WARNING: py:const reference target not found: HT
Doc/library/curses.ascii.rst:42: WARNING: py:const reference target not found: TAB
Doc/library/curses.ascii.rst:44: WARNING: py:const reference target not found: LF
Doc/library/curses.ascii.rst:46: WARNING: py:const reference target not found: NL
Doc/library/curses.ascii.rst:46: WARNING: py:const reference target not found: LF
Doc/library/curses.ascii.rst:48: WARNING: py:const reference target not found: VT
Doc/library/curses.ascii.rst:50: WARNING: py:const reference target not found: FF
Doc/library/curses.ascii.rst:52: WARNING: py:const reference target not found: CR
Doc/library/curses.ascii.rst:54: WARNING: py:const reference target not found: SO
Doc/library/curses.ascii.rst:56: WARNING: py:const reference target not found: SI
Doc/library/curses.ascii.rst:58: WARNING: py:const reference target not found: DLE
Doc/library/curses.ascii.rst:60: WARNING: py:const reference target not found: DC1
Doc/library/curses.ascii.rst:62: WARNING: py:const reference target not found: DC2
Doc/library/curses.ascii.rst:64: WARNING: py:const reference target not found: DC3
Doc/library/curses.ascii.rst:66: WARNING: py:const reference target not found: DC4
Doc/library/curses.ascii.rst:68: WARNING: py:const reference target not found: NAK
Doc/library/curses.ascii.rst:70: WARNING: py:const reference target not found: SYN
Doc/library/curses.ascii.rst:72: WARNING: py:const reference target not found: ETB
Doc/library/curses.ascii.rst:74: WARNING: py:const reference target not found: CAN
Doc/library/curses.ascii.rst:76: WARNING: py:const reference target not found: EM
Doc/library/curses.ascii.rst:78: WARNING: py:const reference target not found: SUB
Doc/library/curses.ascii.rst:80: WARNING: py:const reference target not found: ESC
Doc/library/curses.ascii.rst:82: WARNING: py:const reference target not found: FS
Doc/library/curses.ascii.rst:84: WARNING: py:const reference target not found: GS
Doc/library/curses.ascii.rst:86: WARNING: py:const reference target not found: RS
Doc/library/curses.ascii.rst:88: WARNING: py:const reference target not found: US
Doc/library/curses.ascii.rst:90: WARNING: py:const reference target not found: SP
Doc/library/curses.ascii.rst:92: WARNING: py:const reference target not found: DEL
130After
❯ touch Doc/howto/curses.rst Doc/library/curses*; make -C Doc html SPHINXERRORHANDLING=-n 2>&1 | grep "curses.*WARNING" | tee >(wc -l)
Doc/howto/curses.rst:191: WARNING: py:data reference target not found: curses.LINES
Doc/howto/curses.rst:191: WARNING: py:data reference target not found: curses.COLS
Doc/howto/curses.rst:526: WARNING: py:const reference target not found: ACS_*
Doc/library/curses.rst:179: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:549: WARNING: 'envvar' reference target not found: TERM
Doc/library/curses.rst:578: WARNING: 'envvar' reference target not found: TERM
Doc/library/curses.rst:644: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:644: WARNING: 'envvar' reference target not found: COLS
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNS
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: LINES
Doc/library/curses.rst:668: WARNING: 'envvar' reference target not found: COLUMNS
12
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
|
Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖
|
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Development
Successfully merging this pull request may close these issues.
Uh oh!
There was an error while loading. Please reload this page.
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.