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

Tweak test dep docs #3574

Merged
merged 1 commit into from
Aug 28, 2023
Merged

Conversation

IanButterworth
Copy link
Member

@IanButterworth IanButterworth commented Aug 9, 2023

Alternative proposal to #3533
Closes #3535

@IanButterworth
Copy link
Member Author

It'd be good to get a 2nd opinion from a Pkg dev here, particularly marking the test/Project.toml as an "alternative", which is a bit of a demotion based on discussions like #1788

@gdalle
Copy link
Contributor

gdalle commented Aug 11, 2023

I think it's fair but I understand the hesitation

@IanButterworth IanButterworth mentioned this pull request Aug 18, 2023
14 tasks
@KristofferC KristofferC merged commit 5261b3b into JuliaLang:master Aug 28, 2023
13 checks passed
@IanButterworth IanButterworth deleted the ib/test_dep_docs branch August 28, 2023 10:45
IanButterworth added a commit that referenced this pull request Sep 12, 2023
(cherry picked from commit 5261b3b)
@lgoettgens
Copy link

Should this change imply a deprecation of the test/Project.toml approach? If yes, I would like to see a PSA about this, and maybe some motivation behind this change. I would like to understand, why the reasons that this approach was introduced in julia 1.2 are no longer valid to keep it around.
Furthermore, I wish for a documented way of integrating other sub-projects, most notably docs/Project.toml into the main Project.toml file.

@IanButterworth
Copy link
Member Author

Both approaches are valid. Just that the docs used to be worded in a way that made it seem like test/Project.toml was the new better way.

It's better to characterize it as an experimental way with caveats, caveats that were originally documented.

There's nothing wrong with using either, just that the docs now make it clearer that test/Project.toml has caveats and isn't a replacement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"Test-specific dependencies" documentation needs proofreading
4 participants