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

op-challenger: clarify the output #11141

Merged
merged 2 commits into from
Jul 23, 2024

Conversation

DenseDenise
Copy link
Contributor

For my first time to use ./bin/op-challenger list-claims
The data name really confuses me, after I check the spces, I found the index means for Trace_Index, we should clarify it. And the parent for the root shouldn't be NIL, Because of the missing data, I mistakenly thought that Parent Depth was a whole data, not two data.

@DenseDenise DenseDenise requested a review from a team as a code owner July 12, 2024 06:46
@DenseDenise DenseDenise changed the title op-challenger: clarify the out put op-challenger: clarify the output Jul 12, 2024
Copy link
Contributor

@ajsutton ajsutton left a comment

Choose a reason for hiding this comment

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

These longer names aren't currently reflected din the lineFormat above to ensure the columns line up. The names are deliberately quite succinct to keep the output to a reasonable line length so it can display well in most terminals so I'd rather not increase them. You need a pretty good understanding of dispute games to be able to understand this output anyway.

Also not sure why spaces in titles are being replaced by _.

@DenseDenise
Copy link
Contributor Author

image
image

The reason for adding the hyphen is that without it, attributes with spaces in the middle can easily be misunderstood as two separate attributes rather than one whole attribute. As for the alignment, the arrangement on my CLI is basically the same as before, so there shouldn't be any misalignment. As shown in the picture. @ajsutton

@ajsutton
Copy link
Contributor

ah yeah I can see the new names still fit within the allocated space so the line format doesn't need changing. I'm definitely not a fan of adding in underscores - they just add more visual clutter. I'd also keep Value instead of Claim Value since all of the values are clearly from the claim.

I would also suggest just using Trace instead of Trace Index to keep it shorter - the values make it clear that it's a trace index. And a - instead of N/A for the root parent would reduce clutter a lot.

@DenseDenise
Copy link
Contributor Author

ah yeah I can see the new names still fit within the allocated space so the line format doesn't need changing. I'm definitely not a fan of adding in underscores - they just add more visual clutter. I'd also keep Value instead of Claim Value since all of the values are clearly from the claim.

I would also suggest just using Trace instead of Trace Index to keep it shorter - the values make it clear that it's a trace index. And a - instead of N/A for the root parent would reduce clutter a lot.

Make sense. updated now

Copy link
Contributor

@ajsutton ajsutton left a comment

Choose a reason for hiding this comment

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

Thanks.

@ajsutton ajsutton enabled auto-merge July 23, 2024 00:20
@ajsutton ajsutton added this pull request to the merge queue Jul 23, 2024
Merged via the queue into ethereum-optimism:develop with commit 6f887d5 Jul 23, 2024
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants