Add deprecated option for parameters

[ElliottKasoar]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the Typer documentation, with the integrated search.
• I already searched in Google "How to X in Typer" and didn't find any information.
• I already read and followed all the tutorials in the docs and didn't find an answer.
• I already checked if it is not related to Typer but to Click.

Commit to Help

• I commit to help with one of those options 👆

Example Code

import typer
from typing_extensions import Annotated

app = typer.Typer()


@app.command()
def create(
    username: Annotated[
        str | None, typer.Option(help="Deprecated. Please use --name")
    ] = None,
    name: Annotated[
        str | None, typer.Option(help="Your name")
    ] = None,
):
    print(name, username)

if __name__ == "__main__":
    app()

Description

Currently, my understand is that it's possible to deprecate commands, but not parameters.

This makes the process of deprecating parameters is quite involved, as discussed in a similar request for click: pallets/click#2263. My example code also gives a very simple example, but skips over the additional parsing that's required when you have two parameters that define the same thing.

Click 8.2 added this option, and I was hoping typer could expose/handle this too.

Operating System

macOS

Operating System Details

No response

Typer Version

0.16.0

Python Version

Python 3.12.8

Additional Context

No response