Missing documentation of API

[thmsklngr]

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 tutorial 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 this

Description

I read through the docs and also parts of the code, but it would be great to have a better description of functions and their parameters. Not everything is self descriptive and not every option is used in the docs. For instance, take typer.Option as example:

Option(
    default:Union[Any, NoneType],
    *param_decls:str,
    callback:Union[Callable[..., Any], NoneType]=None,
    metavar:Union[str, NoneType]=None,
    expose_value:bool=True,
    is_eager:bool=False,
    envvar:Union[str, List[str], NoneType]=None,
    shell_complete:Union[Callable[[click.core.Context, click.core.Parameter, str], Union[List[_ForwardRef('click.shell_completion.CompletionItem')], List[str]]], NoneType]=None,
    autocompletion:Union[Callable[..., Any], NoneType]=None,
    show_default:bool=True,
    prompt:Union[bool, str]=False,
    confirmation_prompt:bool=False,
    prompt_required:bool=True,
    hide_input:bool=False,
    is_flag:Union[bool, NoneType]=None,
    flag_value:Union[Any, NoneType]=None,
    count:bool=False,
    allow_from_autoenv:bool=True,
    help:Union[str, NoneType]=None,
    hidden:bool=False,
    show_choices:bool=True,
    show_envvar:bool=True,
    case_sensitive:bool=True,
    min:Union[int, float, NoneType]=None,
    max:Union[int, float, NoneType]=None,
    clamp:bool=False,
    formats:Union[List[str], NoneType]=None,
    mode:Union[str, NoneType]=None,
    encoding:Union[str, NoneType]=None,
    errors:Union[str, NoneType]='strict',
    lazy:Union[bool, NoneType]=None,
    atomic:bool=False,
    exists:bool=False,
    file_okay:bool=True,
    dir_okay:bool=True,
    writable:bool=False,
    readable:bool=True,
    resolve_path:bool=False,
    allow_dash:bool=False,
    path_type:Union[NoneType, Type[str], Type[bytes]]=None,
    rich_help_panel:Union[str, NoneType]=None
) -> Any

Are these options taken from Click or are they Typer specific? This is some sort of information I miss. typer.Argument or typer.Typer are candidates as well for some better explanation. A docstring would already help a little. :)

Regards, Thomas

Operating System

Linux

Operating System Details

No response

Typer Version

0.7.0

Python Version

3.6.15

Additional Context

No response