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.

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

fix(job): remove old region create_job #9914

Merged
merged 1 commit into from
Dec 29, 2024
Merged

fix(job): remove old region create_job #9914

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions jobs/v3/src/main/java/com/google/samples/BasicJobSample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ public static Job generateJobWithRequiredFields(String companyName) {
// [END job_basic_job]

// [START job_create_job]
Copy link
Contributor

Choose a reason for hiding this comment

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

low

Since the create_job tag is being removed, it's a good opportunity to review the remaining job_create_job tag. Is this tag still necessary, or could it be combined with the job_basic_job tag or replaced with a more descriptive comment explaining the purpose of this section of code? Per the Google Java Style Guide, comments should be clear and concise, providing context and explanation where needed.

// [START create_job]

/** Create a job. */
Copy link
Contributor

Choose a reason for hiding this comment

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

low

The Javadoc comment here could be improved by adding more detail about the function's purpose, parameters, return values, and any exceptions it might throw. Following the Google Java Style Guide, the Javadoc should be comprehensive and informative. For example:

/**
 * Creates a job with the specified parameters.
 *
 * @param jobToBeCreated The job object containing the details of the job to be created.
 * @return The created job object.
 * @throws IOException If an I/O error occurs during job creation.
 */

public static Job createJob(Job jobToBeCreated) throws IOException {
Expand All @@ -93,7 +92,6 @@ public static Job createJob(Job jobToBeCreated) throws IOException {
throw e;
}
}
// [END create_job]
// [END job_create_job]

// [START job_get_job]
Expand Down