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

add_shortest_paths() docs do not describe vpaths / epaths #1029

Open
szhorvat opened this issue Dec 28, 2023 · 0 comments · May be fixed by #1626
Open

add_shortest_paths() docs do not describe vpaths / epaths #1029

szhorvat opened this issue Dec 28, 2023 · 0 comments · May be fixed by #1626
Labels
lifecycle Deprecating old APIs
Milestone
upkeep

Comments

@szhorvat
Copy link
Member

The all_shortest_paths() docs describe the vpath and epath components in the return value, but this function actually returns vpaths and epaths (not plural).

I'm not sure what the best way is to deal with cases like this, when several related functions share a doc page. @maelle ?
@maelle maelle added the lifecycle Deprecating old APIs label Jan 22, 2024
@krlmlr krlmlr added this to the upkeep milestone Feb 20, 2024
@maelle maelle linked a pull request Dec 10, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
lifecycle Deprecating old APIs
Projects
None yet
Milestone
upkeep
Development

Successfully merging a pull request may close this issue.

docs: better describe output of all_shortest_paths() igraph/rigraph
3 participants
@szhorvat @krlmlr @maelle