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

Fixing some syntax/stylistic errors #16

Open
ConnieJChi opened this issue Jul 17, 2024 · 0 comments
Open

Fixing some syntax/stylistic errors #16

ConnieJChi opened this issue Jul 17, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@ConnieJChi
Copy link

There are some unused variables all across the codebase. You can see these via VSCode typically under a yellow squiggle.

image

We should also be careful about what is commented in, we should not comment out unused variables and also have commented out print lines

If we want to write documentation for a method, we should use the Java doc format. For example, for a function called create_instance:

/**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */

Of course, there's a lot of code in here and I don't expect this to be fixed in a day, but it's good to keep in mind best practice for coding as we iterate so things don't get difficult to read.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant