Help does not match or needs updated

[bkmetzler]

What happened:
kubectl create --help does not match kubectl create TYPE --help

# kubectl create --help
This has --edit

# kubectl create TYPE --help
Does not have --edit

What you expected to happen:
Wouldn't the base --edit boil up to the 'kubectl create TYPE'? If not, then --edit should be under the kubectl create TYPE --help.

How to reproduce it (as minimally and precisely as possible):

kubectl create --help
<skip unneeded output>
    --edit=false:
	Edit the API resource before creating
<skip unneeded output>

kubectl create deploy --help 
<--edit not listed>

Based on the current documentation I would expect the --edit flag to either be executable as:
kubectl create --edit TYPE <other flags>

Based on my understanding of how GoLang and kubectl is programmed, this should work as well:
kubectl create TYPE --edit

Anything else we need to know?:
Nothing I can think of.

Environment:

• Kubernetes client and server versions (use kubectl version ran from Desktop(see below)):

CMD# kubectl version
Client Version: v1.34.3
Kustomize Version: v5.7.1
Server Version: v1.34.3

• Cloud provider or hardware configuration:
  Ubuntu 24.04.3 image in VirtualBox, locally
  HAProxy to 3 Control Panel nodes (all nodes match versions above)
  Worker nodes are also the same OS version.

OS (e.g: cat /etc/os-release):

• Control Plane and Worker Nodes:

cat /etc/os-release
PRETTY_NAME="Ubuntu 24.04.3 LTS"
NAME="Ubuntu"
VERSION_ID="24.04"
VERSION="24.04.3 LTS (Noble Numbat)"
VERSION_CODENAME=noble
ID=ubuntu
ID_LIKE=debian
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
UBUNTU_CODENAME=noble
LOGO=ubuntu-logo

• Desktop (where kubectl is being ran from):

PRETTY_NAME="Ubuntu 24.04.3 LTS"
NAME="Ubuntu"
VERSION_ID="24.04"
VERSION="24.04.3 LTS (Noble Numbat)"
VERSION_CODENAME=noble
ID=ubuntu
ID_LIKE=debian
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
UBUNTU_CODENAME=noble
LOGO=ubuntu-logo

UPDATE:
I have verified this on the following as well:

$ kubectl version
Client Version: v1.35.0
Kustomize Version: v5.7.1
Server Version: v1.34.3

[ardaguclu]

I agree about the confusion here. The reason of this discrepancy is due to the evolution of kubectl. kubectl create -> kubectl create TYPE -> kubectl apply.

Why we don't move --edit under kubectl create TYPE. Because we strongly recommend using kubectl apply instead of kubectl create.
Why we don't remove --edit entirely from kubectl create. Because it is likely that some old script still relies on this behavior and there is no reason to break the backwards compatibility.

[bkmetzler]

Based on my testing, it looks like --edit does nothing anymore. How about adding a "(deprecated)" in the help? This would clear up the confusion.

[ardaguclu]

Based on my testing, it looks like --edit does nothing anymore. How about adding a "(deprecated)" in the help? This would clear up the confusion.

That looks reasonable to me. Let's wait sometime for more feedback from others.

[mpuckett159]

/triage accepted

[Mujib-Ahasan]

Hey @mpuckett159, I have raised a PR for this. you want to take a look.