Revision - 4d5a20d - Docs: Change "Packages that wrap external libraries or programs [...] - origin: https://github.com/JuliaLang/julia

visit type:

https://github.com/JuliaLang/julia

19 April 2024, 06:28:37 UTC

Revision 4d5a20d39f9d142652c6c4ebbfbe1ed09ea1d066 authored by Dilum Aluthge on 04 March 2024, 11:36:24 UTC, committed by GitHub on 04 March 2024, 11:36:24 UTC

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)

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.

1 parent bc2212c

Files
Changes

Permalinks

Tip revision: 4d5a20d39f9d142652c6c4ebbfbe1ed09ea1d066 authored by Dilum Aluthge on 04 March 2024, 11:36:24 UTC
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)

Tip revision: 4d5a20d

File	Mode	Size
.devcontainer
.github
base
cli
contrib
deps
doc
etc
src
stdlib
test
.buildkite-external-version	-rw-r--r--	5 bytes
.clang-format	-rw-r--r--	3.3 KB
.clangd	-rw-r--r--	114 bytes
.codecov.yml	-rw-r--r--	52 bytes
.git-blame-ignore-revs	-rw-r--r--	371 bytes
.gitattributes	-rw-r--r--	65 bytes
.gitignore	-rw-r--r--	571 bytes
.mailmap	-rw-r--r--	12.7 KB
CITATION.bib	-rw-r--r--	513 bytes
CITATION.cff	-rw-r--r--	1012 bytes
CONTRIBUTING.md	-rw-r--r--	23.4 KB
HISTORY.md	-rw-r--r--	388.1 KB
LICENSE.md	-rw-r--r--	1.3 KB
Make.inc	-rw-r--r--	56.1 KB
Makefile	-rw-r--r--	30.2 KB
NEWS.md	-rw-r--r--	3.6 KB
README.md	-rw-r--r--	7.4 KB
THIRDPARTY.md	-rw-r--r--	3.9 KB
VERSION	-rw-r--r--	11 bytes
julia.spdx.json	-rw-r--r--	37.8 KB
pkgimage.mk	-rw-r--r--	7.1 KB
sysimage.mk	-rw-r--r--	4.2 KB
typos.toml	-rw-r--r--	78 bytes

Showing with 0 additions and 0 deletions (0 / 0 diffs computed)

Computing file changes ...

https://github.com/JuliaLang/julia

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)

README.md