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.

Sign up for GitHub

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

Jump to bottom

add tests for undocumented symbols #52723

Merged
merged 31 commits into from
Jan 14, 2024
Merged

add tests for undocumented symbols #52723

Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
8fcbfe5
add tests for undocumented symbols
stevengj Jan 3, 2024
ccbe7da
Iterators is documented
stevengj Jan 3, 2024
0a9cbe9
Docs test not broken
stevengj Jan 3, 2024
5a4da88
use isempty rather than == []
stevengj Jan 4, 2024
a387859
use isempty rather than == []
stevengj Jan 4, 2024
5f6dfa6
use isempty rather than == []
stevengj Jan 4, 2024
580d3ee
missing Broadcast.dotview
stevengj Jan 4, 2024
75b5ff7
Update checked.jl: docstring check
stevengj Jan 4, 2024
cd41582
Update math.jl: MathConstants docstrings
stevengj Jan 4, 2024
4344981
Update ordering.jl: missing docstrings check
stevengj Jan 4, 2024
596987a
Update test/ordering.jl
stevengj Jan 4, 2024
a7cf9d3
Update sorting.jl: Base.Sort docstrings
stevengj Jan 4, 2024
6eea5aa
Merge branch 'master' into test_undoc
stevengj Jan 4, 2024
b48973e
Update stdlib/Markdown/test/runtests.jl
stevengj Jan 4, 2024
f94c1fc
Update test/docs.jl
stevengj Jan 4, 2024
bf0185d
need to import Base64 module name too
stevengj Jan 4, 2024
91169ed
InteractiveUtils.apropos is public
stevengj Jan 4, 2024
2b7fa9c
apropos has a docstring
stevengj Jan 4, 2024
939b21c
document apropos and doc in the Base.Docs module where they are defin…
stevengj Jan 5, 2024
53933d9
comment fix
stevengj Jan 5, 2024
95c3491
rm redundant docstring for doc
stevengj Jan 5, 2024
a292322
add missing docstring for WindowsRawSocket
stevengj Jan 6, 2024
4cf784a
Merge branch 'master' into test_undoc
stevengj Jan 6, 2024
abb225c
Update stdlib/Markdown/test/runtests.jl
stevengj Jan 6, 2024
8564922
Merge branch 'master' into test_undoc
stevengj Jan 6, 2024
c875e5e
Merge branch 'master' into test_undoc
stevengj Jan 8, 2024
45caec6
unicode docs now merged
stevengj Jan 9, 2024
9718104
Update broadcast.jl: missing "end"
stevengj Jan 9, 2024
8887460
Merge branch 'master' into test_undoc
stevengj Jan 9, 2024
91e465d
Update libc.jl: use doc macro to document inside if ... end
stevengj Jan 10, 2024
f286d44
Merge branch 'master' into test_undoc
LilithHafner Jan 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update test/docs.jl
  • Loading branch information
@stevengj
stevengj committed Jan 4, 2024
commit f94c1fce222d529484bfa17a480111fe336e402e
4 changes: 3 additions & 1 deletion test/docs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1558,5 +1558,7 @@ Base.@ccallable c51586_long()::Int = 3
@test docstrings_equal(@doc(c51586_long()), doc"ensure we can document ccallable functions")

@testset "Docs docstrings" begin
@test isempty(Docs.undocumented_names(Docs))
undoc = Docs.undocumented_names(Docs)
@test_broken isempty(undoc)
@test undoc == [Symbol("@var")]
end
Loading