wwzeng1 / CoralME

A simple, fast and garbage-free matching engine order book that you can use as a starting point for your matching engines.
Apache License 2.0
0 stars 0 forks source link

Remove Redundant Comments in Order.java #37

Open sweep-nightly[bot] opened 2 weeks ago

sweep-nightly[bot] commented 2 weeks ago

Purpose

This pull request removes unnecessary commented-out code and redundant comments from the Order.java file to improve code readability and maintainment.

This pull request was created to solve the following GitHub issue:

Move enums from Order.java to separate files and delete the enums from Order.java

Currently, several enums are defined within the Order.java file. To improve code organization and maintainability, move these enums to their own respective files.

Handle all imports and references in the files.

Enums to be moved (this is not an exhaustive list, please check for any additional enums): Remove the enums from the original Order.java file and move them to their own files.

  • CancelReason
  • ExecuteSide
  • RejectReason
  • Side
  • TimeInForce
  • Type

Description

The changes remove commented-out lines that were previously documenting removed enum definitions. These comments were no longer providing value since the enums have been moved to standalone files, making the comments obsolete and potentially confusing for developers.

This cleanup aligns with best practices of keeping the codebase clean and removing "dead" comments that don't provide additional context or value. The removal of these comments makes the code more maintainable and easier to read without losing any functional documentation.

Summary

Fixes

Fixes #1. Continue the conversation here: http://localhost:3000/c/4a447d92-f81b-4b93-92ca-8919e28ded1a.

To have Sweep make further changes, please add a comment to this PR starting with "Sweep:".

:book: For more information on how to use Sweep, please read our documentation.

Tracking ID: dev-10e126804d
sweep-nightly[bot] commented 2 weeks ago

I'm currently monitoring 72d0f38 for CI failures. This should take about 5-10 min.

:book: For more information on how to use Sweep, please read our documentation.

Tracking ID: dev-10e126804d-ci-0