Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

132 docstrings not included in the manual

Đang mở
  • Có gì không ổn?
#930 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
julia
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs/make.jl và chạy bản build thủ công bằng Documenter, xem xét các docstring còn thiếu được liệt kê và tác động của checkdocs = :exports. Truy vết từng cảnh báo đến API tương ứng đã được ghi tài liệu, sau đó xác minh rằng bản build không còn yêu cầu warnonly = true và các cảnh báo về docstring còn thiếu đã được xử lý.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

When building the manual one gets the message "132 docstrings not included in the manual".

In fact with Documenter 1.x this is an error by default, so I had to set warnonly = true in docs/make.jl for now.

One can pass checkdocs = : exports to makedocs(), then the number of warnings goes down to 70+ but that's still quite a bit.


    DataStructures.counter :: Tuple{Any}
    DataStructures.prefixsum :: Union{Tuple{T}, Tuple{FenwickTree{T}, Integer}} where T
    DataStructures.incdec! :: Union{Tuple{T}, Tuple{FenwickTree{T}, Integer, Integer}, Tuple{FenwickTree{T}, Integer, Integer, Any}} where T
    DataStructures.find_prefixes :: Union{Tuple{T}, Tuple{Trie, T}} where T
    Base.length :: Tuple{BinaryHeap}
    Base.length :: Tuple{CircularBuffer}
    DataStructures.heappop! :: Union{Tuple{AbstractArray}, Tuple{AbstractArray, Base.Order.Ordering}}
    DataStructures.CircularBuffer
    DataStructures.find_root! :: Union{Tuple{T}, Tuple{IntDisjointSet{T}, T}} where T<:Integer
    DataStructures.find_root! :: Union{Tuple{T}, Tuple{DisjointSet{T}, T}} where T
    DataStructures.DefaultDict
    DataStructures.capacity :: Tuple{CircularBuffer}
    DataStructures.capacity :: Tuple{CircularDeque}
    DataStructures.nextreme :: Union{Tuple{T}, Tuple{Base.Order.Ordering, Int64, AbstractVector{T}}} where T
    DataStructures.rb_transplant :: Tuple{RBTree, Union{Nothing, DataStructures.RBTreeNode}, Union{Nothing, DataStructures.RBTreeNode}}
    DataStructures.FasterReverse
    DataStructures.Accumulator
    DataStructures.extract_all_rev! :: Union{Tuple{AbstractHeap{VT}}, Tuple{VT}} where VT
    Base.empty! :: Tuple{CircularBuffer}
    Base.last :: Tuple{CircularBuffer}
    Base.last :: Tuple{CircularDeque}
    Base.getkey :: Union{Tuple{Ord}, Tuple{D}, Tuple{K}, Tuple{SortedDict{K, D, Ord}, Any, Any}} where {K, D, Ord<:Base.Order.Ordering}
    Base.getkey :: Union{Tuple{V}, Tuple{K}, Tuple{RobinDict{K, V}, Any, Any}} where {K, V}
    Base.getkey :: Union{Tuple{V}, Tuple{K}, Tuple{OrderedRobinDict{K, V}, Any, Any}} where {K, V}
    Base.getkey :: Union{Tuple{V}, Tuple{K}, Tuple{SwissDict{K, V}, Any, Any}} where {K, V}
    Base.get :: Union{Tuple{V}, Tuple{K}, Tuple{RobinDict{K, V}, Any, Any}} where {K, V}
    Base.get :: Union{Tuple{V}, Tuple{K}, Tuple{Union{Function, Type}, RobinDict{K, V}, Any}} where {K, V}
    Base.get :: Union{Tuple{V}, Tuple{K}, Tuple{OrderedRobinDict{K, V}, Any, Any}} where {K, V}
    Base.get :: Union{Tuple{V}, Tuple{K}, Tuple{Union{Function, Type}, OrderedRobinDict{K, V}, Any}} where {K, V}
    Base.get :: Union{Tuple{V}, Tuple{K}, Tuple{SwissDict{K, V}, Any, Any}} where {K, V}
    Base.get :: Union{Tuple{V}, Tuple{K}, Tuple{Union{Function, Type}, SwissDict{K, V}, Any}} where {K, V}
    Base.popfirst! :: Tuple{CircularBuffer}
    Base.popfirst! :: Tuple{CircularDeque}
    Base.merge! :: Union{Tuple{Ord}, Tuple{D}, Tuple{K}, Tuple{SortedMultiDict{K, D, Ord}, Vararg{Any}}} where {K, D, Ord<:Base.Order.Ordering}
    Base.merge! :: Tuple{Accumulator, Accumulator}
    DataStructures.isheap :: Union{Tuple{AbstractArray}, Tuple{AbstractArray, Base.Order.Ordering}}
    DataStructures.is_minmax_heap :: Tuple{AbstractVector}
    DataStructures.OrderedRobinDict
    Base.haskey :: Tuple{SwissDict, Any}
    Base.haskey :: Union{Tuple{K}, Tuple{RBTree{K}, K}} where K
    Base.haskey :: Tuple{RobinDict, Any}
    Base.haskey :: Tuple{OrderedRobinDict, Any}
    Base.isempty :: Tuple{BinaryHeap}
    Base.isempty :: Tuple{CircularBuffer}
    Base.first :: Tuple{BinaryHeap}
    Base.first :: Tuple{CircularBuffer}
    Base.first :: Tuple{BinaryMinMaxHeap}
    Base.first :: Tuple{CircularDeque}
    Base.setindex! :: Tuple{CircularBuffer, Any, Int64}
    DataStructures.heapify! :: Union{Tuple{AbstractArray}, Tuple{AbstractArray, Base.Order.Ordering}}
    DataStructures.insert_node! :: Tuple{RBTree, DataStructures.RBTreeNode}
    DataStructures.left_rotate! :: Tuple{RBTree, DataStructures.RBTreeNode}
    Base.pop! :: Union{Tuple{V}, Tuple{K}, Tuple{RobinDict{K, V}, Any, Any}} where {K, V}
    Base.pop! :: Tuple{BinaryHeap}
    Base.pop! :: Tuple{OrderedRobinDict, Any, Any}
    Base.pop! :: Tuple{SwissDict, Any}
    Base.pop! :: Tuple{BinaryMinMaxHeap}
    Base.pop! :: Tuple{CircularBuffer}
    DataStructures.top_with_handle :: Tuple{MutableBinaryHeap}
    DataStructures.minimum_node :: Tuple{RBTree, DataStructures.
Ngôn ngữ chính
Julia
Star
747
Fork
261
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của JuliaCollections/DataStructures.jl

Tất cả issue của JuliaCollections/DataStructures.jl

Issue tương tự

Thêm issue về Julia

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.