[INVESTIGATION] Sections of commented out code

kblincoe / VisualGit_SE701_2019_1

1 stars 0 forks source link

[INVESTIGATION] Sections of commented out code #285

Closed hhagenson28 closed 5 years ago

hhagenson28 commented 5 years ago

Describe the issue There appears to be a lot of commented out code in a number of files in the project. Unsure if any of it is useful but either way, it should either be:

uncommented and incorporated into the project
given a comment as to why it needs to stay there
be deleted from the code base altogether

Commented out code:

initializeGraph.ts : line 42
abstractGraphing.ts : line 15-17
authenticate.ts : line 4-5, line 222,
color.ts : line 4-8
git.ts : line 129-141, line 258-261, line 393, line 424
graphing.ts : line 77-79
graphSetup.ts : line 40, line 142-144, line 231, line 236, line 281-289
images.ts : line 34-40
repo.ts : line 556-576, line 579-580
style.css : line 141-151, lne 161-163,

Acceptance criteria Investigate whether any of the above sections of commented out code are useful and determine what should happen with them.

Jess-Alcantara commented 5 years ago

Approved - definitely helps people understand the code easily if the unused code is removed 👍

twchen97 commented 5 years ago

Approved, would really help readability

rmberriman commented 5 years ago

Approved! Would make it much easier to read :)

cyrus-raitava commented 5 years ago

Hi @hhagenson28, what would your thoughts be on bumping this up to a medium-sized issue? I'm combing through the changes now, and some of them require extensive understanding of the codebase. A 'small' label doesn't seem entirely appropriate.

hhagenson28 commented 5 years ago

@cyrus-raitava Yea I wasn't sure whether it would be a small or medium issue and I didn't look too closely at the code but I'm happy to change it for you as I'm sure it will take a while to figure out what each piece is supposed to be doing :smiley:

cyrus-raitava commented 5 years ago

I've finalised the changes, and relevant explanations - it works out to be quite a large collection of comments. Would it make sense to create a new wiki document to house all of these, for future reference, or just encapsulate these in the thread for the PR? @hhagenson28

hhagenson28 commented 5 years ago

I've finalised the changes, and relevant explanations - it works out to be quite a large collection of comments. Would it make sense to create a new wiki document to house all of these, for future reference, or just encapsulate these in the thread for the PR? @hhagenson28

I think it would be good to have in the wiki as well, for future reference, if that isn't too much trouble to do.

cyrus-raitava commented 5 years ago

@hhagenson28 a PR has been opened, feel free to look through the wiki if you want!