Sort the 0.14 breaking changes by how commonly they come up - #193
Merged
Merged
Conversation
Adds iteration and `length` examples to the `edges` docstring, the two things a caller most often does with an edge iterator and the two the examples left out. Also names the return type as `Graphs.AbstractEdgeIter` and says which concrete type it currently is, so neither reads as a promise the other way.
The changelog now leads with what upgrading actually runs into and the errors to look for, including the cases that give a wrong result instead of an error. It was a flat list in merge order, which put the changes that cost nothing next to the ones that cost the most. The `edges` docstring says what the iterator supports rather than pointing at `Graphs.AbstractEdgeIter`, which is a bare abstract type with no contract of its own.
mtfishman
changed the title
Merge order put the changes that cost nothing next to the ones that cost the most. Also adds the three that fail silently rather than erroring, and folds the entries that moved names around the removed submodule into one describing where they ended up.
mtfishman
changed the title
Lumping them together pointed readers at names that no longer exist.
Each removed submodule is now described where its replacement is, so the `edges` and `vertices` output types and the encode and decode interface come first and the rest follows.
The `eltype` and `length` problems it described were introduced during 0.14 rather than inherited from 0.13, so what changed since 0.13 is the narrowing to `AbstractNamedGraph` and the lazy output. The `eccentricity` and `induced_subgraph` entries are instances of the wrapper signature change, so they move into it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Sorts the 0.14 breaking changes by how commonly they come up rather than by merge order, and adds the three that fail silently rather than erroring.
Also says what the edge iterator guarantees, since
Graphs.AbstractEdgeIterhas no contract of its own.