Skip to content

Remove elliptic1DaddScalarBC.m#405

Open
jbrzensk wants to merge 3 commits into
mainfrom
task/remove_elliptic1DaddscalarBC.m
Open

Remove elliptic1DaddScalarBC.m#405
jbrzensk wants to merge 3 commits into
mainfrom
task/remove_elliptic1DaddscalarBC.m

Conversation

@jbrzensk

@jbrzensk jbrzensk commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Example
  • Documentation

Description

elliptic1DaddScalarBC.m was an example showing how to use addScalarBCs. It does Robin BC on each end. There is already an example for this (ellipic1DLeftRobinRightRobin.m). Removing seems the cleanest option. elliptic1D.m is kept, as the simplest (in terms of lines of code) example solving an elliptic pde.

Related Issues & Documents

@jbrzensk jbrzensk requested a review from Copilot July 2, 2026 16:50
@jbrzensk jbrzensk added the Examples Addition or improvement of examples that showcase the main functionality of the library label Jul 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Removes a redundant MATLAB/Octave elliptic PDE example (elliptic1DaddScalarBC.m) in favor of the already-existing Robin/Robin example, keeping the simpler elliptic1D.m example as the minimal reference.

Changes:

  • Deleted examples/matlab_octave/elliptic1DaddScalarBC.m (duplicative Robin/Robin example).
Comments suppressed due to low confidence (1)

examples/matlab_octave/elliptic1DaddScalarBC.m:1

  • This file is being removed, but the Sphinx docs still link to it (doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-add-Scalar-BC.md:45). After this merge, that link will be broken; please update the docs to remove/replace the MATLAB/OCTAVE link (e.g., point to elliptic1DLeftRobinRightRobin.m if that’s the intended replacement).

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

@codecov

codecov Bot commented Jul 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

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

Comments suppressed due to low confidence (1)

doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-add-Scalar-BC.md:1

  • This page is being removed, but the Sphinx toctree still references Elliptic1D-add-Scalar-BC (doc/sphinx/source/examples/Elliptic/1D/index.md:9). As-is, the docs build will fail with a missing toctree entry; either remove that entry from the index or keep a stub page redirecting to an existing Robin BC example (e.g., Elliptic1D-Left-Robin-Right-Robin).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Examples Addition or improvement of examples that showcase the main functionality of the library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename the elliptic1DaddScalarBC.m example

2 participants