Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update package extension naming docs #4000

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

aplavin
Copy link
Contributor

@aplavin aplavin commented Aug 19, 2024

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, like Plotting -> 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 to Plotting -> ContourExt output). Many packages already follow this short naming, and presumably more will do if it becomes the official recommended way.

@aplavin
Copy link
Contributor Author

aplavin commented Aug 30, 2024

The previous (linked) PR on this topic was #3600, this one is #4000 – even numerology confirms that the question is important :)
Anything to update/fix here?..

Copy link
Member

@IanButterworth IanButterworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but will hold off merging for @KristofferC's review

@aplavin
Copy link
Contributor Author

aplavin commented Sep 19, 2024

bump :)

@IanButterworth
Copy link
Member

I'll merge tomorrow if there are no objections.

@KristofferC
Copy link
Member

Fine by me

@IanButterworth IanButterworth merged commit 5fbfa12 into JuliaLang:master Sep 19, 2024
9 checks passed
@IanButterworth IanButterworth mentioned this pull request Oct 4, 2024
14 tasks
IanButterworth pushed a commit that referenced this pull request Oct 5, 2024
@IanButterworth IanButterworth mentioned this pull request Oct 5, 2024
7 tasks
KristofferC pushed a commit that referenced this pull request Dec 13, 2024
(cherry picked from commit 5fbfa12)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants