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

[Plugin LevelDB] First step of 3414 - Comments and style #3575

Merged
merged 8 commits into from
Nov 18, 2024

Conversation

Jim8y
Copy link
Contributor

@Jim8y Jim8y commented Nov 13, 2024

Description

Credits goes to @cschuchardt88. This is the first task of merging pr-3414 as we discussed. No functional change, just comment and style update. Can be safely merged into master.

Fixes # #3414

Type of change

  • Optimization (the change is only an optimization)
  • Style (the change is only a code style for better maintenance or standard purpose)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Test Configuration:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

cschuchardt88
cschuchardt88 previously approved these changes Nov 13, 2024
Copy link
Contributor

@roman-khimov roman-khimov left a comment

Choose a reason for hiding this comment

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

Missing proper commit description. Still mixing comments and code changes (including new methods) into a single commit.

/// <summary>
/// Moves to the previous entry in the source.
/// After this call, Valid() is true if the iterator was not positioned at the first entry in source.
/// REQUIRES: Valid()
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it? Can I go back to "c" in "a b c" after three "Next" calls and !Valid() (ended) iterator?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Comemnt is from the @cschuchardt88 pr, i did not really check it, but anyway, if its not yet proper, i will remove it until the last minute.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm just suggesting here, I don't know the real behavior, but we want comments to be correct wrt these details.

Copy link
Contributor

Choose a reason for hiding this comment

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

This was a useful comment after all, the only question is Valid() requirement, please return it (maybe except for Valid() line if we don't know for sure). I'm also not sure Valid() requirement is appropriate for Next() (suppose Prev() at a of a b c and Next() then). Needs to be checked.

@Jim8y Jim8y requested a review from cschuchardt88 November 14, 2024 15:32
@NGDAdmin NGDAdmin merged commit ed97f09 into neo-project:master Nov 18, 2024
6 checks passed
@Jim8y Jim8y deleted the pr-3414-1 branch November 18, 2024 15:20
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.

5 participants