trixi-framework / trixi-framework/Trixi.jl

Shorten package extension names as per the Pkg docs

Open
#2,543 1 comment 0 reactions 0 assignees View on GitHub
good first issue refactoring
Dominant language
Julia
Stars
731
Forks
167
Avg merge
2d 18h
Merged PRs (30d)
25

Description

Since (I believe) [v1.10](https://github.com/JuliaLang/Pkg.jl/pull/4000), it is not necessary to include the parent package name in the extension package name. From the [Pkg docs](https://pkgdocs.julialang.org/v1/creating-packages/#Code-structure):

> Extensions can have arbitrary names (here ContourExt), following the format of this example is likely a good idea for extensions with a single dependency. **In Pkg output, extension names are always shown together with their parent package name.**

Contributor guide

Open the contributing guide

Research direction

Start by locating the package extension declarations and compare their names with the Julia Pkg documentation linked in the issue. Shorten extension names so they no longer repeat the parent package name, then run the package's existing tests and inspect Pkg output to confirm the extensions still load and are displayed correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.