Skip to content

Add methods for plotting TriangulateIO#83

Merged
j-fu merged 7 commits intomainfrom
jf/triangulateio
Jun 13, 2025
Merged

Add methods for plotting TriangulateIO#83
j-fu merged 7 commits intomainfrom
jf/triangulateio

Conversation

@j-fu
Copy link
Copy Markdown
Member

@j-fu j-fu commented Jun 13, 2025

These need to be moved away from Triangulate.jl in order to address JuliaGeometry/Triangulate.jl#19

This is another part of technical debt...

These need to be moved away from Triangulate.jl in order to address
JuliaGeometry/Triangulate.jl#19
@j-fu j-fu requested review from Copilot and pjaap June 13, 2025 13:57

This comment was marked as outdated.

Copy link
Copy Markdown
Member

@pjaap pjaap left a comment

Choose a reason for hiding this comment

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

If I got this right, then this is just moved from https://github.com/JuliaGeometry/Triangulate.jl/blob/master/src/plot.jl? I think this should be mentioned somewhere in the code for future code blaming.

An the Copilot comments seem reasonable :)

@pjaap
Copy link
Copy Markdown
Member

pjaap commented Jun 13, 2025

The permalink https://github.com/JuliaGeometry/Triangulate.jl/blob/2aa1196625832b622eb808b165cab8c7a098c6c5/src/plot.jl should be used, since the other file will be gone soon

@j-fu
Copy link
Copy Markdown
Member Author

j-fu commented Jun 13, 2025

Right. Where would you put the code provenance info ? In the moment I put it into comments in the Makie and Pyplot extension.

@j-fu j-fu requested a review from Copilot June 13, 2025 14:44
Copy link
Copy Markdown

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 adds new methods to plot TriangulateIO structures separate from Triangulate.jl to reduce technical debt.

  • Introduces plot_triangulateio and plot_triangulateio! functions for both PyPlot and Makie backends.
  • Updates exports, imports, documentation, examples, and README to integrate the new plotting functionality.

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/dispatch.jl Adds new generic dispatch functions for plotting TriangulateIO structures.
src/GridVisualize.jl Exports the new plotting functions.
ext/GridVisualizePyPlotExt.jl Imports and integrates the new plot_triangulateio! function for the PyPlot backend.
ext/GridVisualizeMakieExt.jl Implements the Makie version of plot_triangulateio! with detailed plotting routines.
examples/plotting.jl Provides an example showcasing the new TriangulateIO plotting functions.
docs/src/api.md Updates API documentation to include the new functions.
docs/make.jl Formats the docs generation script for the new examples.
docs/Project.toml Adds Triangulate dependency to the docs.
README.md Updates the feature table to list the triangulateio plotting support.
Comments suppressed due to low confidence (1)

src/dispatch.jl:986

  • Consider adding a comment or a more explicit signature to clarify the purpose of the empty 'plot_triangulateio' function, ensuring maintainers understand it's an intentional placeholder for method dispatch.
function plot_triangulateio end

@jpthiele
Copy link
Copy Markdown
Contributor

I would put it directly above the snippet that was inserted so if someone does git blame or similar to find out when (and with it mostly why) something was implemented in that function they have a jump off point if they end up at the commits of this PR and need to go further back.

@j-fu j-fu merged commit 45174a3 into main Jun 13, 2025
9 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.

4 participants