aclai-lab / aclai-lab/SolePostHoc.jl

`README.md` lacks straightforward examples

未关闭 适合新手
#102 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Julia
星标
11
派生
1
PR 合并指标
30 天内没有已合并 PR

描述

`README.md` is currently showcasing `julia` markdown with commands to run. Showing the outcomes as well would have more impact, see [this example from SoleLogics' README.md](https://github.com/aclai-lab/SoleLogics.jl/tree/02b8637dbb498bcd81c69856a9329b47a190277b#parsing-and-manipulating-formulas):

```julia-repl
julia> φ1 = parseformula("¬p∧q∨(s∨z)")
SyntaxBranch: (¬p ∧ q) ∨ s ∨ z

julia> syntaxstring(φ1; parenthesize_commutatives = true)
"(¬p ∧ q) ∨ (s ∨ z)"

julia> filter(ψ -> height(ψ) == 1, subformulas(φ1))
2-element Vector{SyntaxTree}:
SyntaxBranch: ¬p
SyntaxBranch: s ∨ z

julia> filter(ψ -> natoms(ψ) == 1, subformulas(φ1))
5-element Vector{SyntaxTree}:
Atom{String}: p
Atom{String}: q
Atom{String}: s
Atom{String}: z
SyntaxBranch: ¬p

julia> φ2 = ⊥ ∨ Atom("t") → φ1
SyntaxBranch: ⊥ ∨ t → (¬p ∧ q) ∨ s ∨ z
```

I suggest replacing those `julia` blocks with `julia-repl` blocks showing the full REPL I/O

贡献指南

这个仓库没有索引到贡献指南

调研方向

Open README.md and find the Julia code blocks that currently show commands without results. Use the linked SoleLogics README example as a reference, replacing those blocks with julia-repl blocks that show the full REPL input and output; done means the examples visibly include their outcomes.

由索引模型根据 Issue 内容生成。

评估

技术栈
julia
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
活跃
描述清晰度
描述清楚
新手友好度
90/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。