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

Doctests are failing #192

Closed
gdalle opened this issue Nov 20, 2022 · 2 comments · Fixed by #305
Closed

Doctests are failing #192

gdalle opened this issue Nov 20, 2022 · 2 comments · Fixed by #305
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@gdalle
Copy link
Member

gdalle commented Nov 20, 2022

Tried to add doctests to runtests.jl in #190 and they exploded. My guess is the documentation outputs are slightly outdated

@gdalle gdalle added bug Something isn't working documentation Improvements or additions to documentation labels Nov 20, 2022
@pgrepds pgrepds mentioned this issue Mar 28, 2023
@pgrepds
Copy link
Contributor

pgrepds commented Mar 28, 2023

I have opened a PR. I have created a list of problematic doc tests, which I have deactivated, there as well.

@gdalle
Copy link
Member Author

gdalle commented May 1, 2023

PR merged but the problematic doctests remain. Copying them

  • 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 added this to the v1.9 milestone Jun 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
No open projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

2 participants