1
resposta

Desafio Docstrings

Colocando funções do projeto Sabor Express, da forma que eu defini no meu código.

1. Exibir nome do programa

def exibir_titulo():
    """Função que mostra o título principal do programa
    
    Output:
    - Nome do Sistema: Sabor Express.
    """

2. Exibir opções

def exibir_opcoes():
    """Função que mostra ao usuário opções disponíveis, que chama a função exibir título,
    eu mostra o título principal e depois disso espera a entrada do usuário, em outra função
    
    Outputs:
    - Título da função exibir_titulo()
    - Funcionalidades(Cadastro, listagem, e alterar status de restaurantes)
    - Opção de encerrar o programa
    """

3. Finalizar app

def encerrar_app():
    """Função que encerra a execução do programa, com o clear, utilizado no linux, que também pode ser
    cls no windows
    
    Outputs:
    - Informa que está encerrando app.py
    
    """

4. Opção Inválida

def opcao_invalida():
    """Função que retorna ao usuário que a opção digitada por ele é inválida, 
    como um default, e depois retorna ao menu principal, para nova digitação
    
    Output:
    - Opção Inválida
    """

5. Exibir subtítulo com parâmetro, para cada função

def exibir_titulo_opc(texto):
    """Função responsável por exibir o título da funcionalidade escolhida, com um valor
    em cada função

    Outputs:
    - Mostra se irá cadastrar, listar, ou alternar status, com uma formatação definida no início
    
    """

6. Cadastrar novo restaurante

def cadastrar_restaurante():
    """Função responsável por cadastrar novos restaurantes
    
    Inputs:
    - Restaurante
    - Categoria

    Outputs:
    - Informa que um restaurante foi cadastrado e seu nome.
    
    """

7. Listar restaurantes

def listar_restaurantes():
    """Função responsável por listar todos os restaurantes
    
    Outputs:
    - Nome, Categoria e Status dos Restaurantes cadastrados, com uma boa formatação de subtítulo

    """

8. Alternar Status dos restaurantes

def alternar_status_restaurante():
    """Função responsável por ativar/desativar restaurantes cadastrados
    
    Inputs:
    - Nome Restaurante

    Outputs
    - Informa se restaurante foi ou não encontrado com a busca no input acima
    - Diz ao usuário, que status foi alternado, se era ativo, ele é desativado e vice-versa
    
    """

9. Escolher opção

def escolher_opcoes():
    """Função que define condicionais para o menu do programa
    
    Input:
    - Selecionar opção a seguir, escolhendo a funcionalidade

    """

10. Main

def main():
    """Fluxo do programa"""

Garanta sua matrícula hoje e ganhe + 2 meses grátis

Continue sua jornada tech com ainda mais tempo para aprender e evoluir

Quero aproveitar agora
1 resposta

Oi, Paulo! Como vai?

Agradeço por compartilhar seu código com a comunidade Alura.

Chamou atenção a organização por funcionalidades e o cuidado em listar entradas e saídas. Na docstring, prefira a primeira frase curta e no imperativo (PEP 257), por exemplo "Exibe o título do programa." em vez de "Função que mostra...".

Continue firme nos estudos.

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