-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
chore(job): delete old region tags from LocationSearchSample.java #9916
base: main
Are you sure you want to change the base?
chore(job): delete old region tags from LocationSearchSample.java #9916
Conversation
Here is the summary of possible violations 😱 There are 2 possible violations for removing region tag in use.
The end of the violation section. All the stuff below is FYI purposes only. Here is the summary of changes. You are about to delete 5 region tags.
This comment is generated by snippet-bot.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi OremGLG, fellow code explorers!
I'm currently reviewing your pull request and will have a full review ready in a few minutes. In the meantime, here's a quick summary to help you and other reviewers get up to speed.
This pull request, titled "chore(job): delete old region tags from LocationSearchSample.java", aims to clean up the LocationSearchSample.java
file by removing outdated region tags. The original tags were likely related to older sample organization, and this update aligns the code with current best practices.
Here's a breakdown of the changes:
- File Affected:
jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java
- Changes: The pull request removes several outdated region tags from the
LocationSearchSample.java
file. Specifically, the following tags have been removed:// [START basic_location_search]
// [END basic_location_search]
// [START keyword_location_search]
// [END keyword_location_search]
// [START city_location_search]
// [END city_location_search]
// [START multi_locations_search]
// [END multi_locations_search]
// [START broadening_location_search]
// [END broadening_location_search]
These were replaced with the newerjob_
prefixed tags.
- Intent: To improve code clarity and maintainability by removing redundant and outdated region tags. This simplifies the code and makes it easier to understand and maintain.
I've checked the diff and the changes seem straightforward and well-executed. I'll provide a more detailed review shortly.
And now, a little haiku to lighten the mood:
Old tags now removed,
Code shines, clean and bright anew,
Review's swift and smooth.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pull request removes outdated region tags from the LocationSearchSample.java
file. This is a good cleanup that improves maintainability. The commit message clearly explains the changes and links to the relevant bug fixes. The checklist is thorough and well-organized. One minor point: the checklist item regarding README changes is unchecked. If the README needs updating to reflect these changes, please do so. Otherwise, remove the item from the checklist.
I didn't find a specific style guide linked in the PR description or the repository, so I'm defaulting to general Java best practices and the Google Java Style Guide where applicable. In this review, I've focused on ensuring comments are clear, concise, and up-to-date, which aligns with general Java best practices.
verify that they aren't in use here: jobs/v3/src/main/java/com/google/samples/LocationSearchSample.java:52, tag basic_location_search(usage: page 1). |
Both regions already have the "job_" preffix in the documentation: Isn't that the file we have to edit for the published page? |
Description
Fixes
b/347826159
basic_location_search -> job_basic_location_search
b/347826166
keyword_location_search -> job_keyword_location_search
b/347826161
city_location_search -> job_city_location_search
b/347826174
multi_locations_search -> job_multi_locations_search
b/384049653
broadening_location_search -> job_broadening_location_search
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
pom.xml
parent set to latestshared-configuration
mvn clean verify
requiredmvn -P lint checkstyle:check
requiredmvn -P lint clean compile pmd:cpd-check spotbugs:check
advisory only