-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Add basic docs for (Lazy)Artifacts stdlibs #39073
Conversation
Looks like the module needs to be explicitly specified in the doctests of |
Artifacts.artifact_meta | ||
Artifacts.artifact_hash | ||
Artifacts.find_artifacts_toml | ||
Artifacts.@artifact_str |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
BTW in case anybody wonders why these four functions and not others: I took the Artifacts API reference in the Pkg.jl documentation and extracted all functions from there which also are in Artifacts.jl, and put them in the above list. That seemed safest: these are functions somebody already decided should appear in a public manual. I think there are a few with docstrings which should not appear here (they are rather about implementation details), but perhaps a few more should appear? In any case, I rather don't want to be the person to decide that; but I'll happily add more here if people request it.
a42e8ea
to
ff53940
Compare
Fixed the first doctest issue, but that now revealed an actual (?) issue in the doctest. |
ff53940
to
37962b9
Compare
The doctest problem is caused by the need to double quote backslashes in strings TWICE in regular doc comments: The source code has this in the doc comment: julia> ret = split_artifact_slash("Foo\\bar\\baz.so"); but this is of course inside a triple-quoted string, so one level of quoting is removed, so the actual content of the doc string are:
and so the One fix (that I just applied) is to use |
37962b9
to
891d461
Compare
891d461
to
9f75e4d
Compare
(cherry picked from commit debf26e)
(cherry picked from commit debf26e)
(cherry picked from commit debf26e)
Some progress on #38462. Certainly could be improved but it's a start.