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

Added docstring for Artifacts.jl #52913

Merged
merged 5 commits into from
Feb 8, 2024

Conversation

jam-khan
Copy link
Contributor

This is a part of issue #52725.

@stevengj
Copy link
Member

You also need to update the test at

@testset "Docstrings" begin
undoc = Docs.undocumented_names(Artifacts)
@test_broken isempty(undoc)
@test undoc == [:Artifacts]
end
to

@testset "Docstrings" begin
    @test isempty(Docs.undocumented_names(Artifacts))
end

Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
@nsajko nsajko added the docs This change adds or pertains to documentation label Jan 17, 2024
@vtjnash vtjnash added the merge me PR is reviewed. Merge when all tests are passing label Feb 7, 2024
stdlib/Artifacts/test/runtests.jl Outdated Show resolved Hide resolved
Copy link
Contributor

@fingolfin fingolfin left a comment

Choose a reason for hiding this comment

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

Seems OK now

@fingolfin fingolfin added the backport 1.10 Change should be backported to the 1.10 release label Feb 8, 2024
@KristofferC KristofferC merged commit 15e2af2 into JuliaLang:master Feb 8, 2024
6 of 8 checks passed
@inkydragon inkydragon removed the merge me PR is reviewed. Merge when all tests are passing label Feb 8, 2024
@KristofferC KristofferC mentioned this pull request Feb 20, 2024
19 tasks
KristofferC added a commit that referenced this pull request Feb 27, 2024
Backported PRs:
- [x] #53205 <!-- Profile: add notes to `print()` docs -->
- [x] #53170 <!-- Remove outdated discussion about externally changing
module bindings -->
- [x] #53228 <!-- SubArray: avoid invalid elimination of singleton
indices -->
- [x] #51361 <!-- code_warntype docs: more neutral reference to
@code_warntype -->
- [x] #50480 <!-- Document --heap-size-hint in Command-line Interface
-->
- [x] #53301 <!-- Fix typo in `Sys.total_memory` docstring. -->
- [x] #53354 <!-- fix code coverage bug in tail position and `else` -->
- [x] #53388 <!-- Fix documentation: thread pool of main thread -->
- [x] #53429 <!-- Subtype: skip slow-path in `local_∀_∃_subtype` if
inputs contain no ∃ typevar. -->
- [x] #53437 <!-- Add debug variant of loader_trampolines.o -->

Need manual backport:
- [ ] #52505 <!-- fix alignment of emit_unbox_store copy -->
- [ ] #53373 <!-- fix sysimage-native-code=no option with pkgimages -->
- [ ] #53439 <!-- staticdata: fix assert from partially disabled native
code -->

Contains multiple commits, manual intervention needed:
- [ ] #52913 <!-- Added docstring for Artifacts.jl -->
- [ ] #53218 <!-- Fix interpreter_exec.jl test -->

Non-merged PRs with backport label:
- [ ] #53424 <!-- yet more atomics & cache-line fixes on work-stealing
queue -->
- [ ] #53125 <!-- coverage: count coverage where explicitly requested by
inference only -->
- [ ] #52694 <!-- Reinstate similar for AbstractQ for backward
compatibility -->
- [ ] #51479 <!-- prevent code loading from lookin in the versioned
environment when building Julia -->
@KristofferC KristofferC mentioned this pull request Mar 12, 2024
25 tasks
IanButterworth pushed a commit that referenced this pull request Apr 11, 2024
This is a part of issue #52725.

---------

Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
Co-authored-by: Max Horn <max@quendi.de>
(cherry picked from commit 15e2af2)
IanButterworth pushed a commit that referenced this pull request Apr 12, 2024
This is a part of issue #52725.

---------

(cherry picked from commit 15e2af2)
Co-Authored-By: Steven G. Johnson <stevenj@mit.edu>
Co-Authored-By: Max Horn <max@quendi.de>
IanButterworth pushed a commit to DilumAluthgeBot/julia that referenced this pull request Apr 12, 2024
This is a part of issue JuliaLang#52725.

---------

Co-authored-by: Steven G. Johnson <stevenj@mit.edu>
Co-authored-by: Max Horn <max@quendi.de>
(cherry picked from commit 15e2af2)
KristofferC added a commit that referenced this pull request Apr 22, 2024
Backported PRs:
- [x] #50759 <!-- Fix outdated usage of scrubbing for log test failures
-->
- [x] #51830 <!-- Add version string to sysimg triple -->
- [x] #53273 <!-- [REPL] Fix typo in using/import completion -->
- [x] #53499 <!-- Avoid compiler warning about redefining jl_globalref_t
-->
- [x] #53424 <!-- yet more atomics & cache-line fixes on work-stealing
queue -->
- [x] #53596 <!-- build: remove extra .a file -->
- [x] #53516 <!-- permit NamedTuple{<:Any, Union{}} to be created -->
- [x] #53643 <!-- Bump CSL to 1.1.1 to fix libgomp bug -->
- [x] #53655 <!-- Change tbaa of ptr_phi to tbaa_value  -->
- [x] #53391 <!-- Default to the medium code model in x86 linux -->
- [x] #53809 <!-- Add missing GC_POP() in emit_cfunction -->
- [x] #53961 <!-- `LazyString` in `LinearAlgebra.checksquare` error
message -->
- [x] #52913 <!-- Added docstring for Artifacts.jl -->
- [x] #53553 <!-- typeintersect: fix `UnionAll` unaliasing bug caused by
@KristofferC KristofferC mentioned this pull request May 8, 2024
23 tasks
@KristofferC KristofferC removed the backport 1.10 Change should be backported to the 1.10 release label May 8, 2024
Drvi pushed a commit to RelationalAI/julia that referenced this pull request Jun 7, 2024
This is a part of issue JuliaLang#52725.

---------

(cherry picked from commit 15e2af2)
Co-Authored-By: Steven G. Johnson <stevenj@mit.edu>
Co-Authored-By: Max Horn <max@quendi.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants