Missing docstrings for public/exported symbols

[stevengj]

This is a tracking issue for public/exported symbols missing docstrings that were identified with the help of #52723. Please check them off as they get fixed and link the corresponding PRs (which should also enable a @test isempty(Docs.undocumented_names(ThisModule)) regression test).

Note that this is separate from the issue of whether those docstrings are included in the manual (#19529).

• Core: AtomicMemoryRef, ConcurrencyViolationError, Exception, GenericMemoryRef, GlobalRef, IO, LineNumberNode, Method, SegmentationFault, TypeVar, arrayref, arrayset, arraysize, const_arrayref

Base and public/exported submodules thereof:

• Base: BufferStream, CanonicalIndexError, CapturedException, Filesystem, IOServer, InvalidStateException, Order, PipeEndpoint, Sort, TTY
• Base.Sys: CPU_NAME, JIT, cpu_info, cpu_summary (add missing docstrings for Base.Sys  #52777)
• Base.Filesystem:
  • File, Filesystem, cptree, futime, rename, sendfile, unlink
  • JL_O_APPEND, JL_O_ASYNC, JL_O_CLOEXEC, JL_O_CREAT, JL_O_DIRECT, JL_O_DIRECTORY, JL_O_DSYNC, JL_O_EXCL, JL_O_FSYNC, JL_O_LARGEFILE, JL_O_NDELAY, JL_O_NOATIME, JL_O_NOCTTY, JL_O_NOFOLLOW, JL_O_NONBLOCK, JL_O_PATH, JL_O_RANDOM, JL_O_RDONLY, JL_O_RDWR, JL_O_RSYNC, JL_O_SEQUENTIAL, JL_O_SHORT_LIVED, JL_O_SYNC, JL_O_TEMPORARY, JL_O_TMPFILE, JL_O_TRUNC, JL_O_WRONLY, S_IRGRP, S_IROTH, S_IRUSR, S_IRWXG, S_IRWXO, S_IRWXU, S_IWGRP, S_IWOTH, S_IWUSR, S_IXGRP, S_IXOTH, S_IXUSR (Add docstring to constants in Base.Filesystem #53247)
• Base.Docs: @var
• Base.Broadcast: dotview
• Base.Order: DirectOrdering, ForwardOrdering, Order, ordtype
• Base.Sort: Algorithm, SMALL_ALGORITHM (add docstring for SMALL_ALGORITHM #53807), SMALL_THRESHOLD, Sort

Standard Library:

• Libdl: Libdl (Added documentation to libdl module #52825)
• TOML: TOML (Add docstring for TOML stdlib module #52834)
• Artifacts: Artifacts (Added docstring for Artifacts.jl #52913)
• Dates: adjust (Add docstring for Dates.adjust #52914)
• Unicode: Unicode ([RFC:] Docstring for Unicode module #52761)
• Markdown: @doc_str, @md_str, html, latex (Docstring for Markdown.html and Markdown.latex #52733 and [Markdown] added doc string for @md_str string literal #52606)
• Serialization: AbstractSerializer, Serializer
• REPL: AbstractREPL, BasicREPL, LineEditREPL, StreamREPL (Added documentation for all repl types #52876)
• Printf: Printf (Documentation for "Printf" Module #52791)
• InteractiveUtils: InteractiveUtils (Add docstring for InteractiveUtils module #53206)
• Profile: Allocs (Adding docstring for the Allocs #53559)
• LinearAlgebra: ColumnNorm, LAPACKException, NoPivot, RankDeficientException, RowMaximum, RowNonZero, copy_transpose! (Documentation update for LinearAlgebra functions #52934)
• Logging: AboveMaxLevel, BelowMinLevel
• FileWatching: FDWatcher, FileMonitor, FolderMonitor, PollingFileWatcher
• SparseArrays: fkeep! (Move fkeep! docstring to the right function JuliaSparse/SparseArrays.jl#503)
• Tar: Tar (Add docstring for Tar module JuliaIO/Tar.jl#173)
• Pkg: PKGMODE_MANIFEST, PKGMODE_PROJECT, PRESERVE_ALL, PRESERVE_ALL_INSTALLED, PRESERVE_DIRECT, PRESERVE_NONE, PRESERVE_SEMVER, PRESERVE_TIERED, PRESERVE_TIERED_INSTALLED, Pkg, PreserveLevel, Registry, UPLEVEL_MAJOR, UPLEVEL_MINOR, UPLEVEL_PATCH

[jariji]

Also for all modules M #52581

• M.include
• M.eval

[stevengj]

(Note that the module-specific include and eval are not marked as public or exported, so I would put them in a separate category.)

[nsajko]

Seems to duplicate issues #26919 and #31202. Also related: #19529, #51335.

[nsajko]

Note that the module-specific include and eval are not marked as public or exported

Sidenote: presumably they should be public.

[fonsp]

Markdown.@md_str is also exported and undocumented, but it did not show up in this list.

[LilithHafner]

I'm guessing this list was created with a buggy Base.Docs.undocumented_names implementation

[Bhavay-2001]

Hi @stevengj , can I work on this issue? Thanks

[LilithHafner]

You can work on this issue! Add some docstrings to names on this list that you understand and make a pull request :)

[Bhavay-2001]

Hi @LilithHafner, adding docstring means writing documentation for the keywords on the list like Base, Base.Sys etc right? Can you please explain what kind of documentation is to be written? Do we have to write about what they do?

[stevengj]

Markdown.@md_str is also exported and undocumented, but it did not show up in this list.

That will be fixed by #52727.