1
resposta

Hora da prática: docstrings - respostas


def exibir_nome_do_programa():
    '''Esta função exibe o nome do programa em caracteres especiais'''


def exibir_opcoes():
    '''Esta função exibe as quatro opções principais do app'''

def finalizar_app():
    '''Esta função encerra o app'''

def opcao_invalida():
    '''Esta função informa que a opção escolhida é inválida'''

def exibir_subtitulo(texto):
    '''Esta imprime na tela o título da opção escolhida pelo usuário'''

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

        Outputs:
        - adicionar um novo restaurante na lista de restaurantes

    '''
  
def listar_restaurantes():
    '''Esta função lista, de forma tabular, os restaurantes cadastrados
    
        outputs:
        nome, categoria e status de todos os restaurantes cadastrados'''
    
   
def alternar_estado_restaurante():
    '''Esta função altera o estado do restaurante ativo/inativo
        input:
        - nome do restaurante
        
        output
        - troca do valor ativo do restaurante escolhido'''
    
   
def escolher_opcao():
    '''Esta função executa a rotina referente a opção escolhida pelo usuário
        Input:
        - opção escolhida pelo usuário
        
        output:
        - executar as funções
            cadastrar_novo_restaurante()
            listar_restaurantes()
            alternar_estado_restaurante()
            finalizar_app()
            opcao_invalida()'''

def main():
    '''Programa principal que executa as rotinas para exibir o nome do programa e as opções 
    de tarefas além de iniciar a rotina de escolha das opções '''
1 resposta

Oi, Ricardo! Como vai?

Seu uso de docstrings ficou bem claro e organizado! A separação entre as funções e a descrição de seus inputs e outputs mostra atenção aos detalhes e contribui bastante para a legibilidade do código.

Uma dica interessante para o futuro é utilizar a função help() para visualizar as docstrings diretamente no terminal Python. Veja este exemplo:


def saudacao():
    '''Imprime uma saudação padrão na tela'''
    print("Bem-vindo!")

help(saudacao)

Esse comando help(saudacao) mostra a descrição da função, o que é útil durante o desenvolvimento ou testes.

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