Skip to content

Draft pull request to review code #4

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.

Sign up for GitHub

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

Draft
Dcruise546 wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Draft pull request to review code #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b0d9861
Updated Dummy comment
Dcruise546 Jun 10, 2021
79c087b
Added Dummy line
Dcruise546 Jun 10, 2021
f1a1686
Added Dummy line
Dcruise546 Jun 10, 2021
c71917a
Added Dummy line
Dcruise546 Jun 10, 2021
c2a9001
Added Dummy line
Dcruise546 Jun 10, 2021
505dd5b
Added Dummy line
Dcruise546 Jun 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@
local.properties
/app/src/androidTest/java/com/example/vehicleinfocheck
/app/src/test/java/com/example/vehicleinfocheck
#dummy edit
Copy link
Collaborator Author

@Dcruise546 Dcruise546 Jun 10, 2021

Choose a reason for hiding this comment

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

This pull request was created only for the purpose of code review!

Please make the recommended changes, commit either to this branch or a separate branch, and assign me again as a reviewer for the final review!

You can discard the 'Dummy lines' I have added as a part of this review process!

General suggestions outside the files changed:

  1. Rename ic_launcher_custom-playstore.png to a more suitable name to represent the icon
  2. .gitignore formatted in chronological order (Preferable a comment splitting the folder names from the file names)
  3. Rename folder 'ml' to something like MachineLearningModel or something!
  4. The same goes for the model name itself. You are writing the code for humans to better understand, so create a rule for naming files and folders and stick to it!
  5. Either remove the test folders completely or add them as a part of .gitignore, there is no use in keeping them if our plan is not to write unit test cases in the first place
  6. Same goes for the path 'test/java/com/example/vehicleinfocheck'

4 changes: 3 additions & 1 deletion app/src/main/java/com/example/vehicleinfocheck/Element.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,6 @@ public void click(){
public String getName(){
return web.run2("javascript:window.HtmlViewer.processContent(" + elementLocator + ".name);");
}
}
}

// Dummy line
2 changes: 2 additions & 0 deletions app/src/main/java/com/example/vehicleinfocheck/ImageActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,5 @@ private void dispatchTakePictureIntent() {
}
}
}

Copy link
Collaborator Author

@Dcruise546 Dcruise546 Jun 10, 2021

Choose a reason for hiding this comment

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

General - same line comment should be limited to 3 words and not more, this will cause comment overflow and will affect the readability of the code

56 - Separate the comments from the code usually by a space or a tab space
127 - assert should be used only when writing unit tests (rules may change for Android though!). Either way, replace it with other conditional statements like If etc.
139 - rename variable c to something meaningful
171 - Comment should align with the code

Summary, this file has too many comments scattered in a random way! Could be grouped on the starting of each method to improve readability! Could also use good spacing to make it look better!

// Dummy line
4 changes: 3 additions & 1 deletion app/src/main/java/com/example/vehicleinfocheck/MainActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,6 @@ protected void onCreate(Bundle savedInstanceState) {

}

}
}

// Dummy line
4 changes: 3 additions & 1 deletion app/src/main/java/com/example/vehicleinfocheck/WebActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,6 @@ private void setSearchButtonListeners() {
});
});
}
}
}

// Dummy line
4 changes: 3 additions & 1 deletion app/src/main/java/com/example/vehicleinfocheck/WebScraper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,6 @@ public void setOnPageLoadedListener(onPageLoadedListener onpageloadedlistener){
public interface onPageLoadedListener{
void loaded(String URL);
}
}
}

// Dummy line