JuliaGraphs / JuliaGraphs/SimpleWeightedGraphs.jl
the `laplacian_matrix` method has a different `dir` parameter default than in `Graphs.jl`, making the doc confusing
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 41
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the laplacian_matrix method for SimpleWeightedDigraph with its documentation and the corresponding definition in Graphs.jl. Determine which default should be authoritative, then update the documentation or implementation so the stated dir default matches actual behavior and verify the resulting REPL documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100