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

Feature/typos 1 #4745

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Feature/typos 1 #4745

wants to merge 4 commits into from

Conversation

sydhds
Copy link
Contributor

@sydhds sydhds commented Sep 19, 2024

  • document all added functions
  • try in sandbox /simulation/labnet
    • if part of node-launch, checked using the resync_check flag
  • unit tests on the added/changed features
    • make tests compile
    • make tests pass
  • add logs allowing easy debugging in case the changes caused problems
  • if the API has changed, update the API specification

@sydhds
Copy link
Contributor Author

sydhds commented Sep 19, 2024

One remaining error reported by typos:

Some(grpc_model::operation_type::Type::ExecutSc(execute_sc));

Fixing the typo on grpc enum Type name should not break compatibility right? @Leo-Besancon @bilboquet

@Leo-Besancon
Copy link
Contributor

One remaining error reported by typos:

Some(grpc_model::operation_type::Type::ExecutSc(execute_sc));

Fixing the typo on grpc enum Type name should not break compatibility right? @Leo-Besancon @bilboquet

I think we have to be careful about:

  • Request params from the JSON-RPC API
  • Maybe response params (but less important)
  • For GRPC, I think it's ok if done in a certain way (for example, the order of the elements do not change), but maybe @bilboquet or @modship can confirm

I don't see other cases that raise issues

@modship
Copy link
Member

modship commented Sep 19, 2024

One remaining error reported by typos:

Some(grpc_model::operation_type::Type::ExecutSc(execute_sc));

Fixing the typo on grpc enum Type name should not break compatibility right? @Leo-Besancon @bilboquet

I think we have to be careful about:

  • Request params from the JSON-RPC API
  • Maybe response params (but less important)
  • For GRPC, I think it's ok if done in a certain way (for example, the order of the elements do not change), but maybe @bilboquet or @modship can confirm

I don't see other cases that raise issues

enum name type come from massa-proto so we should update it if we modify

@sydhds
Copy link
Contributor Author

sydhds commented Sep 20, 2024

One remaining error reported by typos:

Some(grpc_model::operation_type::Type::ExecutSc(execute_sc));

Fixing the typo on grpc enum Type name should not break compatibility right? @Leo-Besancon @bilboquet

Try to serialize with the old name versus the new name and it does not change :)

Waiting for massalabs/massa-proto#67 to be merged

@sydhds
Copy link
Contributor Author

sydhds commented Sep 20, 2024

One remaining error reported by typos:

Some(grpc_model::operation_type::Type::ExecutSc(execute_sc));

Fixing the typo on grpc enum Type name should not break compatibility right? @Leo-Besancon @bilboquet

Try to serialize with the old name versus the new name and it does not change :)

Waiting for massalabs/massa-proto#67 to be merged

The CI of massa-proto reports a breaking change and it's kinda difficult to see the impact in the tooling. Maybe drop this and keep it that way? @Leo-Besancon @bilboquet

@Leo-Besancon
Copy link
Contributor

One remaining error reported by typos:

Some(grpc_model::operation_type::Type::ExecutSc(execute_sc));

Fixing the typo on grpc enum Type name should not break compatibility right? @Leo-Besancon @bilboquet

Try to serialize with the old name versus the new name and it does not change :)
Waiting for massalabs/massa-proto#67 to be merged

The CI of massa-proto reports a breaking change and it's kinda difficult to see the impact in the tooling. Maybe drop this and keep it that way? @Leo-Besancon @bilboquet

This would be fine with me.

@bilboquet
Copy link
Contributor

This would be fine with me.

It's fine to me too until we have time to work on an automatic pipeline for such a change

Copy link
Contributor

@bilboquet bilboquet left a comment

Choose a reason for hiding this comment

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

it looking good

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.

4 participants