1
resposta

Resolução de Atividades - "06 Hora da prática: docstrings"

1 - Crie uma docstring para a função exibir_nome_do_programa()

R: """Essa função tem por objetivo exibir o título do aplicativo (Sabor Express)"""

2 - Crie uma docstring para a função exibir_opcoes()

R: """Essa função exibe as opções disponíveis para o usuário escolher"""

3 - Crie uma docstring para a função finalizar_app()

R: """Essa função informa o usuário e encerra o aplicativo."""

4 - Crie uma docstring para a função opcao_invalida()

R: """ Função usada para caso o usuário digite uma opção que não está disponível

Input:
- Confirmação do usuário para retornar ao menu."""

5 - Crie uma docstring para a função exibir_subtitulo(texto)

R: """Essa função exibe os subtítulos de cada função de forma decorada e com separações de linhas

Input:
- Subtítulo a ser exibido."""

6 - Crie uma docstring para a função cadastrar_novo_restaurante()

R: """ A função é responsável por cadastrar o restaurante inserido pelo usuário e adicionar os dados na lista de estabelecimentos.

Input:
- Nome do restaurante
- Categoria

Output:
- Adiciona os dados para a lista de restaurantes
"""

7 - Crie uma docstring para a função listar_restaurantes()

R: """Essa função exibe os restaurantes disponíveis na lista geral"""

8 - Crie uma docstring para a função alternar_estado_restaurante()

R: """ A função altera o estado de um determinado restaurante, permitindo ativar, caso ele esteja desativado, e vice-versa.

Input:
- Nome do restaurante.

Output:
- Altera o estado do restaurante."""

9 - Crie uma docstring para a função escolher_opcao()

R: """Essa função é chamada para realizar a lógica de escolha quando o usuário digita uma opção.

Input:
- Opção escolhida pela usuário.
"""

10 - Crie uma docstring para a função main()

R: """Função principal Main, responsável por iniciar o aplicativo, determinar o uso de outras funções dá outras providências"""

1 resposta

Ei! Tudo bem, Victor?

Parabéns pela prática! As docstrings estão claras, bem descritas e cumprem o objetivo de documentar cada função. Você explicou bem a responsabilidade de cada método e, quando necessário, indicou entradas e saídas, o que já demonstra uma boa prática de documentação também.

Ótima entrega, continue assim e se surgir dúvidas, compartilhe no fórum.

Alura Conte com o apoio da comunidade Alura na sua jornada. Abraços e bons estudos!