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

Move "Creating Packages" from Pkg.jl docs #52102

Merged
merged 2 commits into from
Nov 17, 2023
Merged

Conversation

LilithHafner
Copy link
Member

@LilithHafner LilithHafner commented Nov 9, 2023

JuliaLang/Pkg.jl#3690 is a part of this PR and should be merged/closed simultaneously. Let's keep discussion here.

The motivation for this move is that the content on this page is not Pkg.jl specific. This isn't a perfect tutorial and this PR does not aim to adjust its contents, simply place it more appropriately and discoverably.

I recall @c42f and @KristofferC expressed interest in this move previously.

@LilithHafner LilithHafner added the domain:docs This change adds or pertains to documentation label Nov 9, 2023
@LilithHafner LilithHafner merged commit 20440fd into master Nov 17, 2023
4 of 7 checks passed
@LilithHafner LilithHafner deleted the lh/add-creating-packages branch November 17, 2023 19:46
@ericphanson
Copy link
Contributor

I think that "Creating packages" section was fulfilling more than just a "tutorial" role; it also seems to be the only place that adding test dependencies was documented (serving as a "reference" function). Since testing is via Pkg.test it seems that Pkg's docs should describe how to add test dependencies.

@LilithHafner
Copy link
Member Author

LilithHafner commented Nov 25, 2023

Agreed. I think the "reference" for Project.toml (including test deps) currently lives in the Project.toml and Manifest.toml section and should include [target], [weakdeps], and [extras] as well.

ViralBShah pushed a commit that referenced this pull request Dec 4, 2023
Since #52102 these links to the
Pkg.jl docs are dead. This should point them to the new location in the
Julia docs.

There is a reference in CONTRIBUTING.md that should change as well, but
maybe not until a Julia version with these changes is released:
https://github.com/JuliaLang/julia/blob/3e4b38684e38a015446253f5752ee9cf840f50cc/CONTRIBUTING.md?plain=1#L17
@fredrikekre
Copy link
Member

I think this should be reverted. When we put together the Pkg docs the idea was to have a complete document for Pkg (duh) similar to e.g. https://doc.rust-lang.org/cargo/. Now there are lots of things missing. I also feel this was done without seemingly any discussion, and in particular I don't think any of the active Pkg developers agreed to this so a bit strange to rip out a page from their docs.

TacHawkes added a commit to TacHawkes/Test.jl that referenced this pull request Feb 13, 2024
KristofferC added a commit that referenced this pull request Apr 10, 2024
As mentioned in
#52102 (comment),
having this information be moved from Pkg to Base creates a quite
uncomfortable split between information about the package manager
between the Pkg docs and Base.

Pkg PR: JuliaLang/Pkg.jl#3818
KristofferC added a commit that referenced this pull request May 6, 2024
As mentioned in
#52102 (comment),
having this information be moved from Pkg to Base creates a quite
uncomfortable split between information about the package manager
between the Pkg docs and Base.

Pkg PR: JuliaLang/Pkg.jl#3818

(cherry picked from commit 3357d1b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain:docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants