Skip to content

Conversation

@ShahuK283
Copy link

Refactors package extension names by removing the redundant 'Trixi' prefix, aligning with Pkg.jl documentation recommendations.

Changes:

  • Renamed files in ext/ (e.g., TrixiSparseConnectivityTracerExt.jl -> SparseConnectivityTracerExt.jl).
  • Updated Project.toml extension keys to match the new filenames.
  • Updated module names in the extension files to remove the Trixi prefix.

Testing:

  • Instantiated the environment and verified that dependencies load correctly using using Trixi.

@github-actions
Copy link
Contributor

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

@JoshuaLampert
Copy link
Member

JoshuaLampert commented Jan 19, 2026

Thanks for the PR! Please note #2543 (comment), i.e., currently the docs of Pkg.jl does not hold what it promises. I already fixed that in julia, see JuliaLang/julia#60456 and it will be backported to julia v1.10, v1.12, and v1.13. It will probably be available in julia v1.10.12v1.10.11, v1.12.5, and v1.13.0-beta2, but neither of these versions is currently released. I would like to wait until at least one of the versions is released.

@DanielDoehring DanielDoehring added the refactoring Refactoring code without functional changes label Jan 19, 2026
@DanielDoehring
Copy link
Member

. It will probably be available in julia v1.10.12, v1.12.5,

Did I miss something? Is 1.10.11 already underway?

@JoshuaLampert
Copy link
Member

JoshuaLampert commented Jan 19, 2026

There is JuliaLang/julia#58889 and the PR was not yet added to that list (in contrast to the corresponding backport PRs for v1.12.5 and v1.13-beta2). So I thought, it will not be included in v1.10.11, but needs to wait for the following patch release. But we'll see. Edit: Now it looks like it will be included in v1.10.11.

Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

As described in the discussion, we should not do this right now (and even when Pkg's printing behavior is changed, I am not sure we really should do this change).

@DanielDoehring DanielDoehring marked this pull request as draft January 20, 2026 14:02
@ShahuK283
Copy link
Author

Thanks for the explanation, @JoshuaLampert and @ranocha! I understand that this depends on the upstream Pkg.jl fix landing in future Julia releases.

I am happy to leave this PR open until those versions are released, or I can close it if you prefer to wait until later to revisit this. Just let me know what works best for the workflow!

@JoshuaLampert
Copy link
Member

I think it's fine to keep it open for now.

@ShahuK283
Copy link
Author

@ranocha @JoshuaLampert As discussed in issue #2335, I have added the regression tests for PlotData2D covering TreeMesh, StructuredMesh, and P4estMesh.

I pushed them to this branch so we can check the CI results. Since this is unrelated to the extension renaming, let me know if you would prefer I open a fresh PR for just the regression tests!

@JoshuaLampert
Copy link
Member

Thanks! Yes, please move this to another branch from which you open a new PR. We can check CI in that new PR.

@ShahuK283
Copy link
Author

Thanks for the guidance! I have moved the regression tests to a new PR as requested: #2765

@ShahuK283 ShahuK283 force-pushed the fix/shorten-extension-names branch from 4ca8157 to 4683378 Compare January 28, 2026 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

refactoring Refactoring code without functional changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants