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

DOC: sparse.csgraph.dijkstra: add warning for directed=False behaviour #20738

Merged
merged 2 commits into from
May 19, 2024

Conversation

bharatr21
Copy link
Contributor

Reference issue

Closes #20509 (Mentioned in #18688 as well?)

What does this implement/fix?

Adds a warning so the user can refer to the notes stating that Dijkstra isn't expected to work correctly under certain conditions when directed=False

Additional information

None

@bharatr21 bharatr21 changed the title DOC: Reference behavior of sparse.csgraph.dijkstra for directed=False DOC: Reference behavior of sparse.csgraph.dijkstra for directed=False May 18, 2024
@github-actions github-actions bot added scipy.sparse scipy.sparse.csgraph Cython Issues with the internal Cython code base Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels May 18, 2024
@lucascolley lucascolley removed the Cython Issues with the internal Cython code base label May 18, 2024
@lucascolley
Copy link
Member

@bdpedigo does this look good to you?

@lucascolley lucascolley changed the title DOC: Reference behavior of sparse.csgraph.dijkstra for directed=False DOC: sparse.csgraph.dijkstra: add warning for directed=False behaviour May 18, 2024
@j-bowhay
Copy link
Member

For future reference, for documentation-only changes please try to save compute resources by adding [docs only] to the end of your commit message as per https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping

@bharatr21
Copy link
Contributor Author

For future reference, for documentation-only changes please try to save compute resources by adding [docs only] to the end of your commit message as per https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping

My apologies, I missed that while going through https://docs.scipy.org/doc/scipy/dev/contributor/rendering_documentation.html#contributing-docs because it was under a "Note", is there a way to make it more prominent or a part of the regular contributing workflow?

… only]

Co-authored-by: Jake Bowhay <60778417+j-bowhay@users.noreply.github.com>
@bharatr21 bharatr21 requested a review from j-bowhay May 18, 2024 15:27
@bdpedigo
Copy link

@bdpedigo does this look good to you?

works for me!

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

Thanks @bharatr21

@j-bowhay j-bowhay added this to the 1.14.0 milestone May 19, 2024
@j-bowhay j-bowhay merged commit 7126706 into scipy:main May 19, 2024
28 of 29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.sparse.csgraph scipy.sparse
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Clarify behavior of sparse.csgraph.dijkstra for directed=False
4 participants