Documentation for pending key and info classes and some other improvements whilst investigating #4553
Conversation
This file contains 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
This prints all entries in the pending table. Intended to be used for learning and unit test debugging. Also intoduce ostream operator << for pending_key and pending_info.
dsiganos
added
the
exclude from changelog
dsiganos
force-pushed
the
pending_key_info_improvements
branch
from
8e78f5d
to
ded54b2
Compare
clemahieu
approved these changes
Apr 13, 2024
pwojcikdev
approved these changes
Apr 13, 2024
pwojcikdev
reviewed
Apr 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The motivation for this PR was a desire to document pending_key and pending_info classes.
However, before I could document them, I needed to understand them.
I created a test case for pending table to help me understand it.
I created a function to print the pending table for learning and debugging purposes.
And whilst creating that test case, I noticed that there were refactoring improvements that could be made.