Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC: add note to example about keeping hard-ref to SpanSelector #14285

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
Jun 2, 2019

Conversation

tacaswell
Copy link
Member

closes #14276

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@tacaswell tacaswell added this to the v3.1-doc milestone May 20, 2019
@ImportanceOfBeingErnest
Copy link
Member

This doesn't seem to have the desired effect: https://21369-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/gallery/widgets/span_selector.html

But even if the "note"-box appeared, would you want it to cut the code in half? Maybe use normal inline comments? Or put the note outside the code, such that it is still copy-pastable as a single entity?

Btw. I guess this note would then need to appear in all the widget examples?

@anntzer
Copy link
Contributor

anntzer commented May 21, 2019

As argued in #10876 (comment) / #10908 (comment) I think CallbackRegistry should just keep strong references...

@tacaswell
Copy link
Member Author

I was trying to cut the code in half, but will go back to just in-line comments.

Copy link
Member

@NelleV NelleV left a comment

Choose a reason for hiding this comment

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

Thanks @tacaswell ! This looks good to me.

@NelleV
Copy link
Member

NelleV commented Jun 1, 2019

@tacaswell Let me know when you fix the rendering issue?

@ImportanceOfBeingErnest
Copy link
Member

@timhoffm Does merging this mean that you will take the responsibility to make sure the note actually appears in a future PR?

@NelleV
Copy link
Member

NelleV commented Jun 2, 2019

It was an improvement in any case. I'm sure someone will at some point see this, and open a PR to fix it.

@timhoffm
Copy link
Member

timhoffm commented Jun 2, 2019

@ImportanceOfBeingErnest I was a bit quick. Assuming you mean #14422.

timhoffm added a commit that referenced this pull request Jun 2, 2019
…285-on-v3.1.0-doc

Backport PR #14285 on branch v3.1.0-doc (DOC: add note to example about keeping hard-ref to SpanSelector)
efiring added a commit that referenced this pull request Jun 3, 2019
…285-on-v3.1.x

Backport PR #14285 on branch v3.1.x (DOC: add note to example about keeping hard-ref to SpanSelector)
@tacaswell tacaswell deleted the doc_spanselector_hardref branch January 20, 2020 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SpanSelector does not work when used in method
6 participants