Skip to content
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

Update Documenter, fix errors/warnings #146

Merged
merged 3 commits into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ jobs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- uses: julia-actions/cache@v2
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
env:
Expand Down
3 changes: 2 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[deps]
AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "0.26"
Documenter = "1.4"
9 changes: 8 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Types with the `IndexedChildren` trait *must* return an indexable object from `c
NodeType
NodeTypeUnknown
HasNodeType
nodetype
```

Providing the `HasNodeType` trait will guarantee that all nodes connected to the node must be of the
Expand Down Expand Up @@ -180,12 +181,18 @@ ischild
isroot
intree
isdescendant
treesize
treebreadth
treeheight
descendleft
getroot
printtree
print_tree
printnode
print_child_key
TreeCharSet
shouldprintkeys
repr_tree
repr_node
```

## Example Implementations
Expand Down
3 changes: 3 additions & 0 deletions docs/src/iteration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ PostOrderDFS
Leaves
Siblings
StatelessBFS
MapNode
treemap
```

Expand All @@ -56,4 +57,6 @@ instance
initial
next
statetype
ascend
descend
```
8 changes: 0 additions & 8 deletions src/AbstractTrees.jl
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
"""
AbstractTrees

This package is intended to provide an abstract interface for working
with tree structures.
Though the package itself is not particularly sophisticated, it defines
the interface that can be used by other packages to talk about trees.
"""
module AbstractTrees

using Base: HasLength, SizeUnknown, HasEltype, EltypeUnknown
Expand Down
2 changes: 1 addition & 1 deletion src/base.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"""
nodevalue(node)

Get the value associated with a node in a tree. This removes wrappers such as [`Indexed`](@ref) or [`TreeCursor`](@ref)s.
Get the value associated with a node in a tree. This removes wrappers such as [`IndexNode`](@ref) or [`TreeCursor`](@ref)s.

By default, this function is the identity.

Expand Down
2 changes: 1 addition & 1 deletion src/iteration.jl
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Obtain the next [`IteratorState`](@ref) after the current one. If `s` is the fi
`nothing`.

This provides an alternative iteration protocol which only uses the states directly as opposed to
[`Base.iterate`](@ref) which takes an iterator object and the current state as separate arguments.
`Base.iterate` which takes an iterator object and the current state as separate arguments.
"""
function next end

Expand Down
2 changes: 1 addition & 1 deletion src/printing.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ signature `g(io::IO, key;)`.
truncated nodes.
* `charset::TreeCharSet` - [`TreeCharSet`](@ref) to use to print branches.
* `printkeys::Union{Bool, Nothing}` - Whether to print keys of child nodes (using
`pairs(children(node))`). A value of `nothing` uses [`printkeys_default`](@ref) do decide the
`pairs(children(node))`). A value of `nothing` uses [`shouldprintkeys`](@ref) to decide the
behavior on a node-by-node basis.
* `printnode_kw = (;)` - keyword arguments to forward to `f`.

Expand Down
Loading