Improve the documentation of the Digraph encoding formats#897
Merged
james-d-mitchell merged 2 commits intodigraphs:mainfrom Mar 18, 2026
Merged
Improve the documentation of the Digraph encoding formats#897james-d-mitchell merged 2 commits intodigraphs:mainfrom
james-d-mitchell merged 2 commits intodigraphs:mainfrom
Conversation
james-d-mitchell
previously approved these changes
Mar 5, 2026
Member
james-d-mitchell
left a comment
james-d-mitchell
left a comment
There was a problem hiding this comment.
Looks great thanks @anujthak, happy to merge modulo one tiny change.
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
2 participants
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.
In response to Issue #47,
Improving documentation around the limitations in encoding/decoding formats of the Digraphs package. Specifically moving the discussion on the four types(Graph6, Digraph6, Sparse6, DiSparse6) to a new section called Encoding Formats that includes their limitations and what type to use when encoding a particular graph. Additionally logged shortcomings when attempting to encode incompatible Graph + Type combinations(example: A graph with loops being encoded as Graph6) and added references to this section throughout Chapter 9 to direct the user.