132 docstrings not included in the manual
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- julia
調査の方向性
docs/make.jl から始めて、Documenter を使って手動ビルドを実行し、一覧にある不足している docstring と checkdocs = :exports の影響を確認します。各警告を対応するドキュメント化された API まで追跡し、その後、ビルドで warnonly = true が不要になり、不足している docstring に関する警告が解消されていることを確認します。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Julia
- スター
- 747
- フォーク
- 261
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
JuliaCollections/DataStructures.jl のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
append!(l1::MutableLinkedList, l2::MutableLinkedList) fails for empty l2対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
JuliaCollections/DataStructures.jl#997 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
-
several `mutable struct` type definitions do not require mutability, review and adjust対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
JuliaCollections/DataStructures.jl の issue をすべて見る
似ている issue
-
io
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
-
docs
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
JuliaGPU/GPUArrays.jl#837 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信