Skip to content

Commit

Permalink
docstrings.jl cleanse
Browse files Browse the repository at this point in the history
  • Loading branch information
mauro-milella committed Nov 2, 2023
1 parent 44a6d75 commit 363eddf
Showing 1 changed file with 0 additions and 138 deletions.
138 changes: 0 additions & 138 deletions src/docstrings.jl
Original file line number Diff line number Diff line change
Expand Up @@ -282,51 +282,6 @@ appearing in a formula.
See also [`Formula`](@ref), [`SyntaxToken`](@ref).
"""

doc_syntaxtree_tokens = """
tokens(φ::SyntaxTree)::AbstractVector{<:SyntaxToken}
TODO
"""

doc_syntaxtree_operators = """
operators(φ::SyntaxTree)::AbstractVector{Operator}
List all operators appearing in a syntax tree.
See also [`atoms`](@ref), [`noperators`](@ref), [`Operator`](@ref), [`tokens`](@ref).
"""

doc_syntaxtree_connectives = """
connectives(φ::SyntaxTree)::AbstractVector{Connective}
List all connectives appearing in a syntax tree.
See also [`atoms`](@ref), [`Connective`](@ref), [`nconnectives`](@ref).
"""

doc_syntaxtree_leaves = """
leaves(φ::SyntaxTree)::AbstractVector{Operator}
List all leaves appearing in a syntax tree.
See also [`atoms`](@ref), [`nleaves`](@ref), [`SyntaxLeaf`](@ref),.
"""

doc_syntaxtree_atoms = """
atoms(φ::SyntaxTree)::AbstractVector{Atom}
List all `Atom`s appearing in a syntax tree.
See also [`Atom`](@ref), [`natoms`](@ref).
"""

doc_syntaxtree_truths = """
truths(φ::SyntaxTree)::AbstractVector{Truth}
List all `Truth`s appearing in a syntax tree.
See also [`Truth`](@ref), [`ntruths`](@ref).
"""

doc_syntaxtree_children = """
children(φ::SyntaxTree)
Expand All @@ -343,99 +298,6 @@ Getter for the token wrapped in a `SyntaxTree`.
See also [`SyntaxBranch`](@ref), [`SyntaxTree`](@ref).
"""

doc_syntaxtree_tokens = """
tokens(φ::SyntaxBranch)
List all tokens appearing in a syntax tree.
See also [`atoms`](@ref), [`ntokens`](@ref), [`operators`](@ref), [`SyntaxToken`](@ref).
"""

doc_syntaxbranch_operators = """
operators(φ::SyntaxBranch)
TODO
"""

doc_syntaxbranch_connectives = """
connectives(φ::SyntaxBranch)
TODO
"""

doc_syntaxtree_tokenstype = """
tokenstype(φ::SyntaxBranch)
Return all the different `SyntaxToken` types contained in the `SyntaxTree` rooted in `φ`.
See also [`Operator`](@ref), [`SyntaxTree`](@ref), [`SyntaxTree`](@ref).
"""

doc_syntaxbranch_operatorstype = """
operatorstype(φ::SyntaxBranch)
Return all the different `SyntaxToken` types contained in the `SyntaxTree` rooted in `φ`.
See also [`SyntaxToken`](@ref), [`SyntaxTree`](@ref), [`SyntaxTree`](@ref).
"""

doc_syntaxbranch_ntokens = """
ntokens(φ::SyntaxBranch)::Integer
Return the count of all `SyntaxToken`s appearing in the `SyntaxTree` rooted in `φ`.
See also [`SyntaxBranch`](@ref), [`SyntaxToken`](@ref), [`SyntaxTree`](@ref), [`tokens`](@ref).
"""

doc_syntaxbranch_noperators = """
noperators(φ::SyntaxTree)::Integer
Return the count of all `Operator`s appearing in the [`SyntaxTree`] rooted in `φ`.
See also [`operators`](@ref), [`SyntaxToken`](@ref).
"""

doc_syntaxbranch_nconnectives = """
nconnectives(φ::SyntaxTree)::Integer
Return the count of all `Connective`s appearing in the [`SyntaxTree`] rooted in `φ`.
See also [`connectives`](@ref), [`SyntaxToken`](@ref).
"""

doc_syntaxbranch_nleaves = """
nleaves(φ::SyntaxBranch)::Integer
Return the count of all `SyntaxLeaf`s appearing in `φ`.
See also [`SyntaxBranch`](@ref), [`SyntaxLeafs`](@ref).
"""

doc_syntaxbranch_ntruths = """
ntruths(φ::SyntaxTree)::Integer
Return the count of all `Truth`s appearing in the [`SyntaxTree`] rooted in `φ`.
See also [`truths`](@ref), [`SyntaxToken`](@ref).
"""

doc_syntaxbranch_atomstype = """
atomstype(φ::SyntaxBranch)
Return all the different `Atom` types contained in the `SyntaxTree` rooted in `φ`.
See also [`Atom`](@ref), [`SyntaxBranch`](@ref), [`SyntaxTree`](@ref), [`SyntaxTree`](@ref).
"""

doc_syntaxbranch_natoms = """
natoms(φ::SyntaxTree)::Integer
Return the count of all `Atom`s appearing in the [`SyntaxTree`] rooted in `φ`.
See also [`atoms`](@ref), [`SyntaxToken`](@ref).
"""


doc_formula_basein = """
Base.in(tok::SyntaxToken, φ::Formula)::Bool
Base.in(tok::SyntaxToken, tree::SyntaxBranch)::Bool
Expand Down

0 comments on commit 363eddf

Please sign in to comment.