8000 Remove suggestions to use `internal` functions by filmor · Pull Request #2092 · pythonnet/pythonnet · GitHub
[go: up one dir, main page]
Skip to content

Remove suggestions to use internal functions #2092

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jan 29, 2023
Merged

Remove suggestions to use internal functions #2092

merged 2 commits into from
Jan 29, 2023

Conversation

filmor
Copy link
Member
@filmor filmor commented Jan 26, 2023

Fixes #2091.

What does this implement/fix? Explain your changes.

...

Does this close any currently open issues?

...

Any other comments?

...

Checklist

Check all those that are applicable and complete.

  • Make sure to include one or more tests for your change
  • If an enhancement PR, please create docs and at best an example
  • Ensure you have signed the .NET Foundation CLA
  • Add yourself to AUTHORS
  • Updated the CHANGELOG

lostmsu
lostmsu reviewed Jan 26, 2023
View reviewed changes
doc/source/dotnet.rst
Comment on lines -50 to -52
When finished using Python APIs, managed code must call a corresponding
``PythonEngine.ReleaseLock`` to release the GIL and allow other threads
to use Python.
Copy link
Member
@lostmsu lostmsu Jan 26, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

IMHO, "when finished" section needs corresponding replacement (maybe merged with the acquisition part).

Copy link
Member Author

Choose a reason for hiding this comment

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

Better?

lostmsu
lostmsu approved these changes Jan 29, 2023
View reviewed changes
Copy link
Member
@lostmsu lostmsu left a comment

Choose a reason for hiding this comment

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

I could see this being confusing a bit in regards with "disposing the return value" - as in "previously returned value" vs "call Py.GIL().Dispose() to release, but probably everyone would read it correctly.

@filmor filmor merged commit c2fa467 into master Jan 29, 2023
@filmor filmor deleted the drop-internal-methods-from-docs branch January 29, 2023 14:00
elan-ajain pushed a commit to elancapital/pythonnet that referenced this pull request Feb 17, 2023
@filmor @elan-ajain
Remove suggestions to use internal functions (pythonnet#2092)
e39260f 
Fixes pythonnet#2091
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lostmsu lostmsu lostmsu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

PythonEngine.AcquireLock and ReleaseLock are marked "internal", but are mentioned in the documentation
2 participants
@filmor @lostmsu
0