update package extension naming docs #4000
Merged
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
IanButterworth
approved these changes
Aug 30, 2024
|
bump :) |
|
I'll merge tomorrow if there are no objections. |
|
Fine by me |
14 tasks
IanButterworth
pushed a commit
that referenced
this pull request
Oct 5, 2024
(cherry picked from commit 5fbfa12)
7 tasks
This was referenced Sep 8, 2024
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.
As discussed in #3600, Pkg output always displays the parent package name next to the extension name. The naming from the current pkg docs example (
PlottingContourExt) makes Pkg output super verbose, likePlotting -> PlottingContourExt. Especially for longer package names, it can easily exceed typical line length.Here, I update the docs to show shorter nonredundant naming,
ContourExt(leading toPlotting -> ContourExtoutput). Many packages already follow this short naming, and presumably more will do if it becomes the official recommended way.