Docs: Change "Packages that wrap external libraries or programs should be named after those libraries or programs" to "Packages that wrap external libraries or programs can be named after those libraries or programs" #53567
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d be named after those libraries or programs" to "Packages that wrap external libraries or programs can be named after those libraries or programs"
DilumAluthge
added
docs
ViralBShah
approved these changes
Mar 2, 2024
oxinabox
approved these changes
Mar 3, 2024
carstenbauer
approved these changes
Mar 3, 2024
tecosaur
pushed a commit
to tecosaur/julia
that referenced
this pull request
Mar 4, 2024
…d be named after those libraries or programs" to "Packages that wrap external libraries or programs can be named after those libraries or programs" (JuliaLang#53567) Before this PR: > Packages that wrap external libraries or programs should be named after those libraries or programs. I think that "should" is a little too strong. After this PR: > Packages that wrap external libraries or programs can be named after those libraries or programs. ## Motivation This might make it a bit easier to convince package authors that they can use a longer more descriptive name for their package, instead of needing to exactly match the name of the underlying software that they are wrapping. Suppose for example that someone is making a Julia package to wrap a piece of software named `HW`. Under the "should be named..." guideline, this would lead the package author to register a Julia package named HW.jl. Personally I'd like to encourage longer and more descriptive names. So, under the "can be named..." guideline, the author won't feel like the Julia package needs to be named HW.jl, and thus they might be more amenable to a longer name such as HelloWorld.jl.
mkitti
pushed a commit
to mkitti/julia
that referenced
this pull request
Apr 13, 2024
…d be named after those libraries or programs" to "Packages that wrap external libraries or programs can be named after those libraries or programs" (JuliaLang#53567) Before this PR: > Packages that wrap external libraries or programs should be named after those libraries or programs. I think that "should" is a little too strong. After this PR: > Packages that wrap external libraries or programs can be named after those libraries or programs. ## Motivation This might make it a bit easier to convince package authors that they can use a longer more descriptive name for their package, instead of needing to exactly match the name of the underlying software that they are wrapping. Suppose for example that someone is making a Julia package to wrap a piece of software named `HW`. Under the "should be named..." guideline, this would lead the package author to register a Julia package named HW.jl. Personally I'd like to encourage longer and more descriptive names. So, under the "can be named..." guideline, the author won't feel like the Julia package needs to be named HW.jl, and thus they might be more amenable to a longer name such as HelloWorld.jl.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this PR:
I think that "should" is a little too strong.
After this PR:
Motivation
This might make it a bit easier to convince package authors that they can use a longer more descriptive name for their package, instead of needing to exactly match the name of the underlying software that they are wrapping.
Suppose for example that someone is making a Julia package to wrap a piece of software named
HW. Under the "should be named..." guideline, this would lead the package author to register a Julia package named HW.jl. Personally I'd like to encourage longer and more descriptive names. So, under the "can be named..." guideline, the author won't feel like the Julia package needs to be named HW.jl, and thus they might be more amenable to a longer name such as HelloWorld.jl.