aclai-lab / aclai-lab/SolePostHoc.jl

`README.md` lacks straightforward examples

Ouverte Adaptée aux débutants
#102 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Julia
Étoiles
11
Forks
1
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

`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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
julia
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
Active
Clarté
Clairement spécifiée
Accessibilité débutants
90/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.