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

Refactor: naming conventions #68

Merged
merged 8 commits into from
Nov 10, 2023
Merged

Refactor: naming conventions #68

merged 8 commits into from
Nov 10, 2023

Conversation

gschup
Copy link
Owner

@gschup gschup commented Nov 10, 2023

To prepare for the next release, it's time to introduce breaking changes!

According to the rust naming conventions, Acronyms should not be fully uppercase. We already do this in bevy_ggrs, now it is time to also implement that change here.

  • Renamed GGRSError to GgrsError
  • Renamed GGRSEvent to GgrsEvent
  • Renamed GGRSRequest to GgrsRequest
  • Also removed deprecated and unused GgrsError variants

Copy link
Contributor

@johanhelsing johanhelsing left a comment

Choose a reason for hiding this comment

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

Good to get this fixed :)

src/error.rs Outdated Show resolved Hide resolved
src/error.rs Outdated Show resolved Hide resolved
@@ -94,7 +94,7 @@ In this document, all remarkable changes are listed. Not mentioned are smaller c

## 0.4.2

- users are now allowed to save `None` buffers for a `GGRSRequest::SaveRequest`. This allows users to keep their own state history and load/save more efficiently
- users are now allowed to save `None` buffers for a `GgrsRequest::SaveRequest`. This allows users to keep their own state history and load/save more efficiently
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe skip the changelog, since we can't change naming for released versions?

Copy link
Owner Author

Choose a reason for hiding this comment

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

I think this should remain as is. It's more of a historical listing than anything else :)

gschup and others added 2 commits November 10, 2023 00:24
Co-authored-by: Johan Klokkhammer Helsing <johanhelsing@gmail.com>
Co-authored-by: Johan Klokkhammer Helsing <johanhelsing@gmail.com>
@gschup gschup merged commit 27c16b1 into main Nov 10, 2023
2 checks passed
@gschup gschup deleted the refactor/naming_conventions branch November 10, 2023 08:58
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