the `laplacian_matrix` method has a different `dir` parameter default than in `Graphs.jl`, making the doc confusing

Aperta
#24 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
julia
Ambito
documentation

Direzione di ricerca

Inizia confrontando il metodo laplacian_matrix per SimpleWeightedDigraph con la relativa documentazione e con la definizione corrispondente in Graphs.jl. Determina quale valore predefinito debba essere quello autorevole, quindi aggiorna la documentazione o l’implementazione in modo che il valore predefinito dichiarato per dir corrisponda al comportamento effettivo e verifica la documentazione REPL risultante.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

breaking

The laplacian_matrix function for SimpleWeightedDigraph uses dir=:out as default for the dir parameter. This contrasts with the definition in Graphs.jl where dir=:both is the default for directed graphs.

While I may agree that dir=:out could be a saner default, the problem is that the documentation of the function is only present in the Graphs package and mentions that the default is dir=:both for directed graphs. After looking at the doc at the REPL, the user may expect the default to be dir=:both when it is in fact dir=:out for SimpleWeightedDigraph.

Lingua principale
Julia
Stelle
41
Fork
9
Merge medio
1g 21h
PR unite (30g)
1

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di JuliaGraphs/SimpleWeightedGraphs.jl

Tutte le issue di JuliaGraphs/SimpleWeightedGraphs.jl

Issue simili

Altre issue su Julia

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.