Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

False Arguments in doc string of save graph #234

Closed
leonardthomson opened this issue Mar 10, 2023 · 1 comment · Fixed by #235
Closed

False Arguments in doc string of save graph #234

leonardthomson opened this issue Mar 10, 2023 · 1 comment · Fixed by #235
Assignees
@aurorarossi
Labels
documentation Improvements or additions to documentation

Comments

@leonardthomson
Copy link

In the docstring you can find an additional input g that doesn't exist in the definition of the function:

Graphs.jl/src/persistence/common.jl

Line 110 in 53cb581

savegraph(file, g, d, format=LGFormat)

vs.

Graphs.jl/src/persistence/common.jl

Lines 118 to 120 in 53cb581

function savegraph(
fn::AbstractString, d::Dict{T,U}, format::AbstractGraphFormat; compress=nothing
) where {T<:AbstractString} where {U<:AbstractGraph}

No big mistake, but little confusing and easy to fix.
Thank you!
@aurorarossi
Copy link
Member

Thank you for pointing that out!

@aurorarossi aurorarossi self-assigned this Mar 10, 2023
@aurorarossi aurorarossi mentioned this issue Mar 10, 2023
Merged
@aurorarossi aurorarossi added the documentation Improvements or additions to documentation label Mar 12, 2023
@gdalle gdalle linked a pull request May 1, 2023 that will close this issue
Fix docstring issue #234 #235
Merged
gdalle pushed a commit that referenced this issue May 1, 2023
@aurorarossi
Fix docstring issue #234 (#235)
783f8be 
* Remove g

* Improve docstring

* Remove default format from signature

* Add example

* FIx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aurorarossi aurorarossi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docstring issue #234 aurorarossi/Graphs.jl
2 participants
@leonardthomson @aurorarossi