1
resposta

Minha solução

Olá. Tudo bem?

Segue a minha solução:

def exibir_nome_do_programa():
    ''' 
    Essa função é responsável por imprimir o nome do programa.
    '''


def exibir_opcoes():
    ''' 
    Essa função é responsável por imprimir as opções da lista.
    '''


def finalizar_app():
    ''' 
    Essa função é responsável por encerrar o programa.
    '''


def voltar_ao_menu_principal():
    ''' 
    Essa função é responsável por solicitar ao usuário que pressione uma tecla para voltar ao menu principal.
    '''


def opcao_invalida():
    ''' 
    Essa função é responsável por imprimir uma mensagem de opção inválida e chamar a função voltar_ao_menu_principal() para o usuário tentar selecionar uma opção novamente.
    '''


def exibir_subtitulo(texto):
    ''' 
    Essa função é responsável por imprimir um subtitulo com um texto.
    
    Inputs:
        texto (str): O texto do subtitulo.
    '''


def cadastrar_novo_restaurante():
    ''' 
    Essa função é responsável por cadastrar um novo restaurante.
    
    Inputs:
        - Nome do restaurante
        - Categoria

    Outputs:
        - Adiciona um novo restaurante à lista de restaurantes.
    '''


def listar_restaurantes():
    ''' 
    Essa função é responsável por listar os restaurantes.
    '''


def alterar_estado_restaurante():
    ''' 
    Essa função é responsável por alterar o estado de um restaurante (ativo/desativado).
    '''


def escolher_opcao():
    ''' 
    Essa função é responsável por permitir ao usuário escolher uma opção do menu.
    '''


def main():
    ''' 
    Função principal que inicia o programa.
    '''
1 resposta

Oi, Roberto! Como vai?

Obrigada por compartilhar sua solução! É muito gratificante poder acompanhar você compreendendo a ideia de como criar docstrings em Python, que são muito úteis para documentar as funções e ajudar outros desenvolvedores a entenderem o que cada função faz.

Deixo como sugestão apenas inserir um texto dentro das docstrings criadas. Por exemplo, para a função exibir_nome_do_programa(), podemos adicionar uma docstring assim:

def exibir_nome_do_programa():
    ''' 
    Essa função é responsável por imprimir o nome do programa.
    '''
    print("Nome do Programa")

Nesse caso, a docstring explica que a função exibir_nome_do_programa() é responsável por imprimir o nome do programa.

Fazendo algo semelhante para todas as outras funções definidas. Espero ter ajudado! Caso tenha ficado alguma dúvida, sinta-se à vontade em comunicar, estou à disposição!

Um forte abraço e bons estudos!