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

chore(job): delete region tag: create_job at jobs/v3/api_client/base_job_sample.py #12998

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

eapl-gemugami
Copy link
Contributor

Description

Fixes Internal: b/347825738

Checklist

@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Dec 13, 2024
Copy link

@code-review-assist code-review-assist bot left a comment

Choose a reason for hiding this comment

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

Hi @eapl-gemugami and reviewers,

I'm currently reviewing this pull request and will post my full review in a few minutes. In the meantime, here's a quick summary to help everyone get up to speed:

This PR addresses internal issue b/347825738 by removing the redundant [START create_job] and [END create_job] tags from the jobs/v3/api_client/base_job_sample.py file. The change specifically removes lines 56 and 73. The intent is to clean up the code and improve readability by removing duplicate markers. The [START job_create_job] and [END job_create_job] tags remain, indicating the relevant code section.

The changes are limited to the base_job_sample.py file, affecting only the comment markers related to the create_job function. No functional changes are introduced; only the comments are modified.

Here's a little poem to lighten the mood:

A tag's misplaced might,
Cause confusion, a slight fright,
Remove it with care,
Code's clarity to share.

Looking forward to a thorough review!

@product-auto-label product-auto-label bot added the api: jobs Issues related to the Cloud Talent Solution Job Search API. label Dec 13, 2024
Copy link

@code-review-assist code-review-assist bot left a 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 a region tag associated with the create_job function. While the code changes themselves are minor, the pull request description is missing a key detail: It does not indicate which issue this change addresses. Please add this information to the description to provide context for reviewers. Additionally, since the region tag is being removed, it's important to verify that the corresponding documentation has been updated to remove any references to the now-nonexistent tag. Please confirm this has been done, and update the README if necessary.

@@ -53,7 +53,6 @@ def generate_job_with_required_fields(company_name):


# [START job_create_job]

Choose a reason for hiding this comment

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

high

This change removes the create_job region tag. Please confirm that the associated documentation has been updated to reflect this change. If the documentation still references this tag, it will lead to broken links or outdated examples.

@@ -70,7 +69,6 @@ def create_job(client_service, job_to_be_created):
raise e


# [END create_job]
# [END job_create_job]

Choose a reason for hiding this comment

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

high

This removes the closing tag for the create_job snippet. It's crucial to double-check that all corresponding start and end tags are correctly paired and updated across all relevant files. Mismatched or missing tags can cause issues with documentation generation and code examples.

@eapl-gemugami eapl-gemugami added the snippet-bot:force-run Force snippet-bot runs its logic label Dec 13, 2024
@snippet-bot snippet-bot bot removed the snippet-bot:force-run Force snippet-bot runs its logic label Dec 13, 2024
Copy link

snippet-bot bot commented Dec 13, 2024

Here is the summary of possible violations 😱

There is a possible violation 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 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: jobs Issues related to the Cloud Talent Solution Job Search API. samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant