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

added constants.py and test_constants.py #28

Merged
merged 13 commits into from
Dec 8, 2023

Conversation

wolff01
Copy link
Collaborator

@wolff01 wolff01 commented Nov 10, 2023

No description provided.

@gkapfham
Copy link
Contributor

Connects to issue #15.

@gkapfham gkapfham self-requested a review November 13, 2023 16:08
Copy link
Contributor

@gkapfham gkapfham left a comment

Choose a reason for hiding this comment

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

Hello @wolff01, there are a significant number of changes that you need to make to this PR. Primarily, there are a number of constants defined inside of this module that are not absolutely needed. Please delete all of the constants that are not needed. If a constant is currently inside of this module then it needs to be clearly used in the existing source code of the Cellveyor tool.

@jnormile
Copy link
Collaborator

@wolff01, would you also be able to elaborate on the PR and provide a description--make it super clear to all reviewers (which will include at least one other student) what the intent of the PR is?

@hayleepierce hayleepierce added the in-progress This pull request is in progress. label Nov 14, 2023
@hayleepierce hayleepierce linked an issue Nov 14, 2023 that may be closed by this pull request
@wolff01
Copy link
Collaborator Author

wolff01 commented Nov 17, 2023

Made more changes to the constants.py file that are needed for cellveyor. There are possibly more to adjust I wanted to make sure that we have the constants.py for cellveyor, I know @hayleepierce is working on the logging, we have collaborated and come up with the solution that I push this while she works on logging and creates that in the constants.py

@wolff01 wolff01 added the ready-for-review This pull request is ready for review. label Nov 17, 2023
@hayleepierce hayleepierce requested review from gkapfham, rodriguez03 and hayleepierce and removed request for AidanNeeson November 17, 2023 16:23
cellveyor/main.py Outdated Show resolved Hide resolved
cellveyor/constants.py Show resolved Hide resolved
cellveyor/constants.py Outdated Show resolved Hide resolved
@jnormile jnormile removed the ready-for-review This pull request is ready for review. label Nov 21, 2023
Copy link
Contributor

@gkapfham gkapfham left a comment

Choose a reason for hiding this comment

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

Hello @wolff01, please note that we can't merge this PR until it is clear that each of the constants that you are proposing is actually used in the application's source code. If you have questions about this, please check in with me or @jnormile or @hayleepierce and we can clarify further what we are requesting for you to change!

@wolff01
Copy link
Collaborator Author

wolff01 commented Nov 30, 2023

The constants file is complete for a base usage. For anymore data that needs to be added for anyone else you should be set to go.

@hayleepierce hayleepierce added ready-for-review This pull request is ready for review. and removed in-progress This pull request is in progress. labels Nov 30, 2023
@wolff01
Copy link
Collaborator Author

wolff01 commented Dec 1, 2023

The constants.py added notation for indentation and insertion of a new line when called in any area in the markers section. Also stored within is a Human readable boolean and an overview of Cellveyor with basic information and as well the filesystem.

Copy link
Collaborator

@jnormile jnormile left a comment

Choose a reason for hiding this comment

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

I'm not seeing convincing evidence that the constants defined in constants.py are being used outside of constants.py. As the PR currently stands, it looks like it's adding a lot of code that isn't necessarily doing anything.

Could you elaborate on why you believe using constants.py to be a good idea? The current implementation doesn't convince me.

@wolff01
Copy link
Collaborator Author

wolff01 commented Dec 1, 2023

@jnormile The constants.py is needed in order to store values and not have the worry of accidentally changing the values stored within it in the main code. It will help improve readability and be better to maintain than not having it. The values inside of the constants.py file can be properly stored instead of having an extensive amount of data in our main.

@wolff01
Copy link
Collaborator Author

wolff01 commented Dec 1, 2023

More data will be added for certain classes as well as new classes will be added. This base is to give use a solidified class Cellveyor as well as other small things such as a human readable boolean and markers like indentation and new line notation.

@jnormile
Copy link
Collaborator

jnormile commented Dec 5, 2023

To be clear, my main concern with this PR is that it adds a lot of code that isn't actually in use. From what I can tell, there's only one line in main.py that's actually making use of the constants code you're adding.

If we're going to use the constants approach you're proposing, then I ask that you take up the suggestion made by @hayleepierce and actually integrate the constants you're creating throughout cellveyor. Otherwise we have a significant amount of "dead code" being pushed into the repository. This type of bloat makes team-based projects like this ultimately harder to maintain.

@hayleepierce hayleepierce self-requested a review December 5, 2023 20:30
tests/test_constants.py Outdated Show resolved Hide resolved
tests/test_constants.py Outdated Show resolved Hide resolved
@hayleepierce hayleepierce self-requested a review December 5, 2023 20:41
Copy link
Collaborator

@hayleepierce hayleepierce left a comment

Choose a reason for hiding this comment

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

Thank you for all your work on this issue!

@hayleepierce
Copy link
Collaborator

@wolff01 Please don't forget to sync your fork!

@hayleepierce hayleepierce requested a review from jnormile December 5, 2023 20:53
Copy link
Collaborator

@jnormile jnormile left a comment

Choose a reason for hiding this comment

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

Thanks for cutting this down in size to help ensure its more maintainable! Approved!

@AidanNeeson AidanNeeson self-requested a review December 8, 2023 14:11
Copy link

@AidanNeeson AidanNeeson left a comment

Choose a reason for hiding this comment

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

Nice work!

@jnormile jnormile merged commit 300a4d9 into GatorEducator:master Dec 8, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-review This pull request is ready for review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a constants.py module and create classes
5 participants