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.

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

fix doctests #239

Merged
merged 4 commits into from
May 1, 2023
Merged

fix doctests #239

merged 4 commits into from
May 1, 2023

Conversation

pgrepds
Copy link
Contributor

@pgrepds pgrepds commented Mar 28, 2023

I have fixed all jldoctest as proposed by issue #192.

There are some cases for which I have deactivated the jldoctest and which might need further attention.

I have deactivated the following jldoctests

  • modularity.jl has a reference on SimpleWeightedGraph which is not included by Graphs.jl.
  • transitivity.jl in the function transitiveClosure. The issue here is that Documenter.jl truncates the output. Thus, it is not fully visible. We could compare the truncated output instead. However, it might then differ from the output which is seen by the user.
  • shortestpaths.jl in the function has_negative_weight_cycle in src/Experimental. The SPFA package is not found. The same happens in spfa.jl.
  • spfa.jl in spfa_shortest_paths. The output is compared to an error message. However, the full stack trace is obviously not included.
  • euclidiagraphs.jl uses random values. We might want to add a local doc filter.
  • randgraphs.jl uses random values. We might want to add a local doc filter here as well.

@gdalle gdalle self-requested a review May 1, 2023 06:08
Copy link
Member

@gdalle gdalle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the painstaking work @pgrepds, this will definitely increase code reliability!!!

@codecov
Copy link

codecov bot commented May 1, 2023

Codecov Report

Merging #239 (7213fc5) into master (5649092) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master     #239   +/-   ##
=======================================
  Coverage   97.23%   97.23%           
=======================================
  Files         114      114           
  Lines        6583     6583           
=======================================
  Hits         6401     6401           
  Misses        182      182           

@gdalle gdalle merged commit 2011e0d into JuliaGraphs:master May 1, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants