JuliaLang/julia

Missing docstrings for public/exported symbols

Open

#52,725 opened on 2024年1月3日

GitHub で見る
 (47 comments) (15 reactions) (0 assignees)Julia (5,773 forks)batch import
docsgood first issuehelp wanted

Repository metrics

Stars
 (48,709 stars)
PR merge metrics
 (平均マージ 20d 6h) (30d で 157 merged PRs)

説明

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, PipeEndpoint, TTY
  • Base.Sys: CPU_NAME, JIT, cpu_info, cpu_summary (#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 (#53247)
  • Base.Docs: @var
  • Base.Broadcast: dotview (#62026)
  • Base.Order: DirectOrdering, ForwardOrdering, Order, ordtype (#62025)
  • Base.Sort: Algorithm, SMALL_ALGORITHM (#53807), SMALL_THRESHOLD, Sort (#62026)

Standard Library:

  • Libdl: Libdl (#52825)
  • TOML: TOML (#52834)
  • Artifacts: Artifacts (#52913)
  • Dates: adjust (#52914)
  • Unicode: Unicode (#52761)
  • Markdown: @doc_str, @md_str, html, latex (#52733 and #52606)
  • Serialization: AbstractSerializer, Serializer (#61310)
  • REPL: AbstractREPL, BasicREPL, LineEditREPL, StreamREPL (#52876)
  • Printf: Printf (#52791)
  • InteractiveUtils: InteractiveUtils (https://github.com/JuliaLang/julia/pull/53206)
  • Profile: Allocs (#53559)
  • LinearAlgebra: ColumnNorm, LAPACKException, NoPivot, RankDeficientException, RowMaximum, RowNonZero, copy_transpose! (#52934)
  • Logging: AboveMaxLevel, BelowMinLevel
  • FileWatching: FDWatcher, FileMonitor, FolderMonitor, PollingFileWatcher
  • SparseArrays: fkeep! (https://github.com/JuliaSparse/SparseArrays.jl/pull/503)
  • Tar: Tar (https://github.com/JuliaIO/Tar.jl/pull/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

コントリビューターガイド