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

docs: better describe output of all_shortest_paths() #1626

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

maelle
Copy link
Contributor

@maelle maelle commented Dec 10, 2024

Fix #1029

@szhorvat I'll need your help.

Copy link
Contributor

aviator-app bot commented Dec 10, 2024

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This pull request is currently open (not queued).

How to merge

To merge this PR, comment /aviator merge or add the mergequeue label.


See the real-time status of this PR on the Aviator webapp.
Use the Aviator Chrome Extension to see the status of your PR within GitHub.

R/structural.properties.R Outdated Show resolved Hide resolved
Comment on lines +797 to +798
#' but the vectors of the list contain the edge ids along the shortest paths,
#' instead of the vertex ids.}
Copy link
Member

Choose a reason for hiding this comment

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

Nitpick: Let's decide whether we write "ID" or "id" and stick to it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Please add your preference in #1683

R/structural.properties.R Outdated Show resolved Hide resolved
@szhorvat
Copy link
Member

$res is for backwards compatibility. It is the same as $vpath. It is effectively deprecated. The deprecation should be made explicit, and it should be removed soon.

@krlmlr
Copy link
Contributor

krlmlr commented Jan 6, 2025

@maelle: Should this be part of the upcoming 2.1.3?

@maelle
Copy link
Contributor Author

maelle commented Feb 13, 2025

@krlmlr @szhorvat suggests deprecated res. For this we'd need #1576 I'd be curious to see you add this during a hackathon so I have a better chance of doing it myself another time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add_shortest_paths() docs do not describe vpaths / epaths
3 participants