Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add standard external names to nitpick_ignore #106948

Closed
serhiy-storchaka opened this issue Jul 21, 2023 · 1 comment
Closed

Docs: add standard external names to nitpick_ignore #106948

serhiy-storchaka opened this issue Jul 21, 2023 · 1 comment
Labels
docs Documentation in the Doc dir

Comments

@serhiy-storchaka
Copy link
Member

serhiy-storchaka commented Jul 21, 2023

@serhiy-storchaka serhiy-storchaka added the docs Documentation in the Doc dir label Jul 21, 2023
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Jul 21, 2023
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
serhiy-storchaka added a commit that referenced this issue Jul 22, 2023
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Jul 22, 2023
…pythonGH-106949)

It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH"..
(cherry picked from commit f8b7fe2)

Co-authored-by: Serhiy Storchaka <[email protected]>
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Jul 22, 2023
…pythonGH-106949)

It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH"..
(cherry picked from commit f8b7fe2)

Co-authored-by: Serhiy Storchaka <[email protected]>
serhiy-storchaka added a commit to serhiy-storchaka/cpython that referenced this issue Jul 22, 2023
…pythonGH-106949)

It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".

(cherry picked from commit f8b7fe2)

Co-authored-by: Serhiy Storchaka <[email protected]>
ambv pushed a commit that referenced this issue Jul 23, 2023
…06949) (#107061)

It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH"..
(cherry picked from commit f8b7fe2)
ambv pushed a commit that referenced this issue Jul 23, 2023
…06949) (#107060)

* [3.12] gh-106948: Add standard external names to nitpick_ignore (GH-106949)

It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".

(cherry picked from commit f8b7fe2)

Co-authored-by: Serhiy Storchaka <[email protected]>

* Delete 2023-05-31-18-37-57.gh-issue-105156.R4El5V.rst
erlend-aasland added a commit that referenced this issue Jul 23, 2023
…tility functions and system calls (#107062)

Co-authored-by: Serhiy Storchaka <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 23, 2023
…, OS utility functions and system calls (pythonGH-107062)

(cherry picked from commit b447e19)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
erlend-aasland added a commit that referenced this issue Jul 23, 2023
…s, OS utility functions and system calls (GH-107062) (#107154)

(cherry picked from commit b447e19)

Co-authored-by: Erlend E. Aasland <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
erlend-aasland added a commit that referenced this issue Jul 23, 2023
…s, OS utility functions and system calls (#107062) (#107157)

(cherry picked from commit b447e19)

Co-authored-by: Serhiy Storchaka <[email protected]>
mementum pushed a commit to mementum/cpython that referenced this issue Jul 23, 2023
…nGH-106949)

It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH".
mementum pushed a commit to mementum/cpython that referenced this issue Jul 23, 2023
…, OS utility functions and system calls (python#107062)

Co-authored-by: Serhiy Storchaka <[email protected]>
carljm added a commit to carljm/cpython that referenced this issue Jul 24, 2023
* main: (73 commits)
  Thoroughly refactor the cases generator (python#107151)
  Docs: Add missing markup to Argument Clinic docs (python#106876)
  pythongh-107162: Document errcode.h usage in its comment (python#107177)
  pythongh-106320: Remove private _PyDict C API (python#107145)
  Fix PyVectorcall_Function doc versionadded (python#107140)
  Docs: Remove duplicate word in Argument Clinic howto heading (python#107169)
  pythongh-107017: Change Chapter Strings to Texts in the Introduction chapter. (python#107104)
  pythongh-106320: Remove private _PyObject C API (python#107159)
  Docs: fix typo in os.pwrite docstring (python#107087)
  pythongh-105291: Add link to migration guide for distutils (python#107130)
  pythongh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (python#107062)
  pythongh-106320: Remove _PyBytes_Join() C API (python#107144)
  pythongh-106320: Remove private _PyObject C API (python#107147)
  pythongh-106320: Remove _PyTuple_MaybeUntrack() C API (python#107143)
  pythongh-106320: Remove _PyIsSelectable_fd() C API (python#107142)
  Remove superflous whitespaces in `layout.html`. (pythonGH-107067)
  pythongh-107122: Update what's news for dbm.*dbm.clear() method (pythongh-107135)
  pythongh-107122: Add clear method to dbm.ndbm module (pythongh-107126)
  pythongh-62519: Make pgettext search plurals when translation is not found (python#107118)
  pythongh-107122: Add clear method to dbm.gdbm.module (pythongh-107127)
  ...
vstinner added a commit to vstinner/cpython that referenced this issue Jul 25, 2023
Maintaining nitpick_ignore Python list in conf.py is a burden. Add a
YAML configuration file which is easier to maintain.
vstinner added a commit to vstinner/cpython that referenced this issue Jul 25, 2023
Maintaining nitpick_ignore Python list in conf.py is a burden. Add a
YAML configuration file which is easier to maintain.

Ignore also standard C types in the "c:identifier" domain.
vstinner added a commit to vstinner/cpython that referenced this issue Jul 25, 2023
Maintaining nitpick_ignore Python list in conf.py is a burden. Add a
YAML configuration file which is easier to maintain.

Ignore also standard C types in the "c:identifier" domain.

Update Doc/requirements-oldest-sphinx.txt.
vstinner added a commit to vstinner/cpython that referenced this issue Jul 26, 2023
…domain

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-Authored-By: Serhiy Storchaka <[email protected]>
vstinner added a commit that referenced this issue Jul 26, 2023
…#107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-authored-by: Serhiy Storchaka <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jul 26, 2023
…domain (pythonGH-107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

(cherry picked from commit b1de380)

Co-authored-by: Victor Stinner <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
vstinner added a commit that referenced this issue Jul 26, 2023
… domain (GH-107295) (#107297)

gh-106948: Update documentation nitpick_ignore for c:identifer domain (GH-107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

(cherry picked from commit b1de380)

Co-authored-by: Victor Stinner <[email protected]>
Co-authored-by: Serhiy Storchaka <[email protected]>
vstinner added a commit to vstinner/cpython that referenced this issue Jul 26, 2023
…domain (python#107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-authored-by: Serhiy Storchaka <[email protected]>
(cherry picked from commit b1de380)
vstinner added a commit that referenced this issue Jul 26, 2023
… domain (#107295) (#107299)

gh-106948: Update documentation nitpick_ignore for c:identifer domain (#107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-authored-by: Serhiy Storchaka <[email protected]>
(cherry picked from commit b1de380)
vstinner added a commit to vstinner/cpython that referenced this issue Jul 26, 2023
Complete nitpick_ignore list in Doc/conf.py to ignore more standard C
functions, variables, macros, and also Win32 API functions and
macros.
vstinner added a commit to vstinner/cpython that referenced this issue Jul 26, 2023
Complete nitpick_ignore list in Doc/conf.py to ignore more standard C
functions, variables, macros, and also Win32 API functions and
macros.
vstinner added a commit to vstinner/cpython that referenced this issue Jul 26, 2023
Complete nitpick_ignore list in Doc/conf.py to ignore more standard C
functions, variables, macros, and also Win32 API functions and
macros.

No longer ignore "__int" C type: it should not be used in the doc.
jtcave pushed a commit to jtcave/cpython that referenced this issue Jul 27, 2023
…domain (python#107295)

Update the nitpick_ignore of the documentation configuration to fix
Sphinx warnings about standard C types when declaring functions with
the "c:function" markups.

Copy standard C types declared in the "c:type" domain to the
"c:identifier" domain, since "c:function" markup looks for types in
the "c:identifier" domain.

Co-authored-by: Serhiy Storchaka <[email protected]>
@serhiy-storchaka
Copy link
Member Author

It's all for now. Additional names can be added in separate issues or even without opening a special issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

1 participant