Skip to content

Proposed wording for extended module destructor documentation #1031

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 1 commit into from
Aug 25, 2017

Conversation

wjakob
Copy link
Member

@wjakob wjakob commented Aug 25, 2017

This PR extends the module destructor documentation with a few more examples targeting other use cases/requirements.

Copy link
Member

@dean0x7d dean0x7d left a comment

Choose a reason for hiding this comment

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

LGTM, I just noted a couple of typos.

(whether this is acceptable will generally depend on the application).

Alternatively, the capsule may also be stashed within a type object, which
ensures that it not called before all instances of that type have been
Copy link
Member

Choose a reason for hiding this comment

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

it not -> it is not


.. code-block:: cpp

// Register a callback function that is invoked when the BaseClass object is colelcted
Copy link
Member

Choose a reason for hiding this comment

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

colelcted -> collected

@wjakob wjakob merged commit 5f317e6 into pybind:master Aug 25, 2017
@wjakob
Copy link
Member Author

wjakob commented Aug 25, 2017

thanks, merged!

@dean0x7d dean0x7d modified the milestone: v2.2 Aug 30, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants