Skip to content

Commit

Permalink
Docs: change "Package naming guidelines" to "Package naming rules" (#…
Browse files Browse the repository at this point in the history
…53566)

I think that "guidelines" implies that these are just optional
suggestions.

But in practice, I think we usually insist that these are followed.

So I think it might be worth changing "guidelines" to "rules", to
clarify that we enforce these.
  • Loading branch information
DilumAluthge committed Mar 5, 2024
1 parent 6745160 commit 892c491
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/src/tutorials/creating-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -563,10 +563,10 @@ duplicated into `[extras]`. This is an unfortunate duplication, but without
doing this the project verifier under older Julia versions will throw an error
if it finds packages under `[compat]` that is not listed in `[extras]`.

## Package naming guidelines
## Package naming rules

Package names should be sensible to most Julia users, *even to those who are not domain experts*.
The following guidelines apply to the `General` registry but may be useful for other package
The following rules apply to the `General` registry but may be useful for other package
registries as well.

Since the `General` registry belongs to the entire community, people may have opinions about
Expand Down

0 comments on commit 892c491

Please sign in to comment.