C API docs: an `int` valued function cannot return "true"

[jwuttke]

Documentation

Here https://docs.python.org/3/c-api/unicode.html#c.PyUnicode_Check, and probably in many other places:

int PyUnicode_Check([PyObject](https://docs.python.org/3/c-api/structures.html#c.PyObject) *obj)

    Return true if the object obj is a Unicode object or an instance of a Unicode subtype. This function always succeeds.

This is not the degree of precision I would expect from an API reference. The return value is int, not bool, therefore true is unprecise.

Correct wording: "Return 1 if ... Otherwise return 0."

Linked PRs

• gh-129362: Modified Return Type Statement in Documentation #129473

[AA-Turner]

We would welcome a PR! You may find reading the Developer's Guide (devguide) useful on setting up an environment for documentation.

A

[vstinner]

"true" is the right word: it's an expression evaluated to "true" by if (expr) for example. We sometimes refer to it as "non-zero".

I suggest to close the issue.