Skip to content

gh-113437: Update documentation about PyUnicode_AsWideChar() function #113455

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

Merged
merged 5 commits into from
Feb 13, 2024
Merged

gh-113437: Update documentation about PyUnicode_AsWideChar() function #113455

merged 5 commits into from
Feb 13, 2024

Conversation

qqwqqw689
Copy link
Contributor

@qqwqqw689 qqwqqw689 commented Dec 24, 2023

Update documentation about PyUnicode_AsWideChar() function.


📚 Documentation preview 📚: https://cpython-previews--113455.org.readthedocs.build/

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Dec 24, 2023
@qqwqqw689 qqwqqw689 changed the title Update documentation about PyUnicode_AsWideChar() function Update documentation about PyUnicode_AsWideChar() function. Issues #113437 Dec 24, 2023
@qqwqqw689 qqwqqw689 changed the title Update documentation about PyUnicode_AsWideChar() function. Issues #113437 Update documentation about PyUnicode_AsWideChar() function. Dec 24, 2023
@hugovk hugovk changed the title Update documentation about PyUnicode_AsWideChar() function. Update documentation about PyUnicode_AsWideChar() function Dec 25, 2023
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whitespace and formatting:

@@ -854,7 +854,8 @@ wchar_t Support
Copy the Unicode object contents into the :c:type:`wchar_t` buffer *wstr*. At most
*size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing
null termination character). Return the number of :c:type:`wchar_t` characters
copied or ``-1`` in case of an error. Note that the resulting :c:expr:`wchar_t*`
copied or ``-1`` in case of an error. When :c:type:`wchar_t` buffer *wstr* is NULL, return
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
copied or ``-1`` in case of an error. When :c:type:`wchar_t` buffer *wstr* is NULL, return
copied or ``-1`` in case of an error. When :c:type:`wchar_t` buffer *wstr* is ``NULL``, return

@@ -854,7 +854,8 @@ wchar_t Support
Copy the Unicode object contents into the :c:type:`wchar_t` buffer *wstr*. At most
*size* :c:type:`wchar_t` characters are copied (excluding a possibly trailing
null termination character). Return the number of :c:type:`wchar_t` characters
copied or ``-1`` in case of an error. Note that the resulting :c:expr:`wchar_t*`
copied or ``-1`` in case of an error. When :c:type:`wchar_t` buffer *wstr* is NULL, return
the length of the Unicode object plus one.Note that the resulting :c:expr:`wchar_t*`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the length of the Unicode object plus one.Note that the resulting :c:expr:`wchar_t*`
the length of the Unicode object plus one. Note that the resulting :c:expr:`wchar_t*`

@hugovk hugovk changed the title Update documentation about PyUnicode_AsWideChar() function gh-113437: Update documentation about PyUnicode_AsWideChar() function Dec 25, 2023
@encukou encukou merged commit 5719aa2 into python:main Feb 13, 2024
@encukou encukou added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 13, 2024
@miss-islington-app
Copy link

Thanks @qqwqqw689 for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @qqwqqw689 for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 13, 2024
…nction (pythonGH-113455)

(cherry picked from commit 5719aa2)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Feb 13, 2024

GH-115407 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 13, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 13, 2024
…nction (pythonGH-113455)

(cherry picked from commit 5719aa2)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Feb 13, 2024

GH-115408 is a backport of this pull request to the 3.11 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.11 only security fixes label Feb 13, 2024
encukou pushed a commit that referenced this pull request Feb 14, 2024
…unction (GH-113455) (GH-115407)

(cherry picked from commit 5719aa2)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
encukou pushed a commit that referenced this pull request Feb 14, 2024
…unction (GH-113455) (GH-115408)

(cherry picked from commit 5719aa2)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
fsc-eriker pushed a commit to fsc-eriker/cpython that referenced this pull request Feb 14, 2024
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 skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants