Skip to content

chore: add 2 return type hints in update-user-guide-links.py#54953

Open
travellingsoldier85 wants to merge 1 commit intokubernetes:mainfrom
travellingsoldier85:auto-improve/type_hint/0ae24f-202603180902
Open

chore: add 2 return type hints in update-user-guide-links.py#54953
travellingsoldier85 wants to merge 1 commit intokubernetes:mainfrom
travellingsoldier85:auto-improve/type_hint/0ae24f-202603180902

Conversation

@travellingsoldier85
Copy link
Copy Markdown

Summary

Added concrete return type annotations to functions in content/bn/docs/update-user-guide-links.py based on static analysis of return statements.

Changes

  • Add return type hint -> list to function
  • Add return type hint -> str to function

Type of Change

  • Code quality improvement (type hints)
  • Bug fix
  • New feature

Motivation

These type annotations are inferred from actual return values in the function bodies (e.g. return True-> bool, return []-> list). They improve:

  • IDE autocompletion and type checking (mypy/pyright)
  • Code readability for contributors navigating the codebase
  • Bug prevention via static analysis

No functional changes — only type annotations added.

@linux-foundation-easycla
Copy link
Copy Markdown

CLA Not Signed

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Welcome @travellingsoldier85!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign imtiaz1234 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot requested a review from asem-hamid March 18, 2026 09:03
@k8s-ci-robot k8s-ci-robot added the area/localization General issues or PRs related to localization label Mar 18, 2026
@k8s-ci-robot k8s-ci-robot requested a review from sajibAdhi March 18, 2026 09:03
@k8s-ci-robot k8s-ci-robot added language/bn Issues or PRs related to Bengali language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 18, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 18, 2026

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 10adb54
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/69ba6a3cc9e62f0008cfb81c
😎 Deploy Preview https://deploy-preview-54953--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@asem-hamid
Copy link
Copy Markdown
Contributor

@travellingsoldier85 Thanks a lot for your contribution

It looks like the CLA (Contributor License Agreement) hasn’t been signed yet. Could you please complete that? It’s required for us to accept contributions. You should see a prompt/check in this PR to guide you.

Also, for documentation updates, we first make changes in the English (en) version, and then propagate those changes to other localized versions. So please ensure the update is applied in the en content first.

Once these are done, we can take another look. Thanks again for your contribution!

Copy link
Copy Markdown
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/easycla

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/localization General issues or PRs related to localization cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. language/bn Issues or PRs related to Bengali language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants