Skip to content

Clean up#13

Merged
CSSFrancis merged 3 commits into
mainfrom
clean-up
May 12, 2026
Merged

Clean up#13
CSSFrancis merged 3 commits into
mainfrom
clean-up

Conversation

@CSSFrancis
Copy link
Copy Markdown
Owner

This PR cleans up the documentation and adds back in some examples that were not re-added to the git tracking after they were split off. This should better prepare the package for a 0.1.0 release.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates package metadata and documentation in preparation for the 0.1.0 release, and re-introduces a set of gallery/example scripts under Examples/PlotTypes to support the docs and user onboarding.

Changes:

  • Added PEP 621 project metadata (readme/license/authors/classifiers/URLs) to pyproject.toml.
  • Cleaned up and corrected multiple documentation pages (API/dev/getting started) and updated module naming.
  • Added a suite of plot-type examples (1D, 2D, mesh, 3D, insets, bars) under Examples/PlotTypes/.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
upcoming_changes/11.maintenance.rst Fixes wording/typos in a towncrier maintenance fragment.
pyproject.toml Adds core packaging metadata (readme/license/authors/classifiers/URLs).
Examples/PlotTypes/README.rst Introduces a short README for the PlotTypes example set.
Examples/PlotTypes/plot_spectra1d.py Adds a worked 1D spectra example demonstrating overlays and widgets.
Examples/PlotTypes/plot_pcolormesh.py Adds a non-linear axes pcolormesh example with overlays.
Examples/PlotTypes/plot_line_styles.py Adds a focused example of linestyles/alpha/markers and setters.
Examples/PlotTypes/plot_inset.py Adds an inset-plot example demonstrating floating inset panels.
Examples/PlotTypes/plot_image2d.py Adds an imshow + histogram + widgets example (has a marker-coordinate bug).
Examples/PlotTypes/plot_bar.py Adds a comprehensive bar chart example including grouped/log-scale updates.
Examples/PlotTypes/plot_3d.py Adds a 3D plotting example (surface/scatter/line + live updates).
docs/getting_started.rst Updates API references to the public anyplotlib.* exports.
docs/dev/index.rst Updates dev docs (test paths/module layout); contains an on_change vs on_changed mismatch.
docs/api/index.rst Refines API landing page wording and consolidates Axes/Plots/Layout description.
docs/api/figure_plots.rst Renames the “Figure Plots” page title to “Axes, Plots & Layout”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/dev/index.rst Outdated
Comment thread Examples/PlotTypes/plot_image2d.py Outdated
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.31%. Comparing base (437b5ef) to head (f79d001).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #13   +/-   ##
=======================================
  Coverage   78.31%   78.31%           
=======================================
  Files          29       29           
  Lines        2389     2389           
=======================================
  Hits         1871     1871           
  Misses        518      518           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@CSSFrancis CSSFrancis merged commit ebee481 into main May 12, 2026
12 checks passed
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.

3 participants