Skip to content
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

Update examples to use :class:~.Axes and deprecate :class:~.GraphScene #1598

Merged
merged 59 commits into from May 31, 2021

Conversation

hydrobeam
Copy link
Member

@hydrobeam hydrobeam commented May 29, 2021

Changelog / Overview

:class:~.GraphScene has been deprecated and its functionality has been shifted to :class:~.Axes. See the updated example gallery for sample usage.

Motivation

This is the final step in shifting over completely to Axes/CoordinateSystem away from GraphScene

Explanation for Changes

The examples that use GraphScene in the example gallery were updated. They all kept the same visuals, except for HeatDiagramPlot, which had its tick count reduced.

Documentation Reference

Testing Status

Further Comments

This PR is dependent on #1472

Checklist

  • I have read the Contributing Guidelines
  • I have written a descriptive PR title (see top of PR template for examples)
  • I have written a changelog entry for the PR or deem it unnecessary
  • My new functions/classes either have a docstring or are private
  • My new functions/classes have tests added and (optional) examples in the docs
  • My new documentation builds, looks correctly formatted, and adds no additional build warnings

Reviewer Checklist

  • The PR title is descriptive enough
  • The PR is labeled correctly
  • The changelog entry is completed if necessary
  • Newly added functions/classes either have a docstring or are private
  • Newly added functions/classes have tests added and (optional) examples in the docs
  • Newly added documentation builds, looks correctly formatted, and adds no additional build warnings

@hydrobeam hydrobeam added pr:deprecation Deprecation, or removal of deprecated code documentation Improvements or additions to documentation labels May 29, 2021
@hydrobeam hydrobeam linked an issue May 29, 2021 that may be closed by this pull request
@hydrobeam hydrobeam added the pr:dependent This PR or issue requires that another PR is merged first label May 29, 2021
@github-actions github-actions bot removed the pr:dependent This PR or issue requires that another PR is merged first label May 29, 2021
@sebpearce
Copy link
Contributor

Just wanted to say thanks for the effort here. I am just learning about graph stuff now and having up-to-date docs really helps.

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

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

Purely based on looking at the rendered output: looks great, and IMO ready to ship. I have added one non-blocking comment.

docs/source/examples.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@Nikhil0504 Nikhil0504 left a comment

Choose a reason for hiding this comment

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

LGTM

@behackl behackl merged commit 8691284 into ManimCommunity:master May 31, 2021
@friedkeenan friedkeenan changed the title Update examples to use :class:Axes and deprecate :class:GraphScene Update examples to use :class:~.Axes and deprecate :class:~.GraphScene May 31, 2021
@hydrobeam hydrobeam deleted the get_rid_of_graphscene branch August 23, 2021 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pr:deprecation Deprecation, or removal of deprecated code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GraphScene/coordinate_systems refactoring
4 participants