Skip to content

fix: correct code example language inconsistency in pt-BR docs #3088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

irineub
Copy link
Contributor

@irineub irineub commented Jun 30, 2025

Este PR atualiza os exemplos de código da documentação em português do Brasil (pt-BR), traduzindo-os do inglês para o português, com o objetivo de manter a consistência entre o texto e os exemplos apresentados.

Alterações realizadas:
Tradução de exemplos de código para o português.
Eu Mantive a estrutura original dos documentos.
Com isso melhorei a legibilidade e clareza para leitores brasileiros.

Motivação:
Os exemplos estavam em inglês enquanto o restante da documentação está em português, o que pode dificultar a compreensão para leitores menos familiarizados com o idioma. Esta atualização melhora a acessibilidade e a experiência de leitura da documentação em pt-BR.

@joaomdmoura
Copy link
Collaborator

Disclaimer: This review was made by a crew of AI Agents.

Código Review Comentário: Melhorias na Documentação do CrewAI em pt-BR

Resumo do Pull Request

Este pull request visa melhorar a consistência das documentações e exemplos de código na documentação em português (pt-BR) do CrewAI, através da tradução de comentários, strings e nomes de variáveis, enquanto mantém a funcionalidade do código.

Análise das Alterações e Recomendações

1. Consistência de Tradução

  • Ponto Positivo: As traduções preservam o significado semântico e são adaptadas ao contexto do português.
  • Pontuação de Melhoria: Alguns arquivos possuem uso de idiomas mistos nos exemplos de código. Recomendo revisar todos os exemplos e garantir que estejam completamente em português.

2. Convenções de Nomeação de Variáveis

  • Ponto Positivo: As variáveis foram nomeadas de forma descritiva em português.
  • Pontuação de Melhoria: Algumas variáveis ainda estão em inglês, criando inconsistência. Sugiro a renomeação para seguir totalmente a convenção portuguesa. Por exemplo, o nome agent pode ser substituído por agente.

3. Tradução de Strings de Documentação

  • Ponto Positivo: A tradução das strings de documentação é abrangente.
  • Pontuação de Melhoria: Algumas strings multilinhas podem ser melhor formatadas. Utilizar aspas triplas quando necessário, como nas strings longas do backstory.

Sugestões Específicas com Exemplos

Exemplo 1: Configuração do Agente (agents.mdx)

Atual:

agent = Agent(
    role="Cientista de Dados Sênior",
    goal="Analisar e interpretar dados",
    backstory="Com mais de 10 anos de experiência...",
)

Sugerido:

agente_dados = Agent(
    role="Cientista de Dados Sênior",
    goal="Analisar e interpretar conjuntos de dados complexos",
    backstory="""
        Com mais de 10 anos de experiência em ciência de dados...
    """,
)

Exemplo 2: Definições de Tarefas (tasks.mdx)

Atual:

task = Task(
    description="Analyze the given dataset and calculate the average age",
    expected_output="The average age of the participants.",
)

Sugerido:

tarefa_analise = Task(
    description="Analise o conjunto de dados e calcule a idade média dos participantes.",
    expected_output="Relatório com a média de idade.",
)

Exemplo 3: Configuração da Equipe (crews.mdx)

Atual:

crew = Crew(
    agents=my_agents,
    tasks=my_tasks,
    process=Process.sequential
)

Sugerido:

equipe = Crew(
    agents=agentes_projeto,
    tasks=tarefas_analise,
    process=Process.sequential,
)

Recomendações Gerais

  1. Convenção de Nomeação: Utilize nomes em português para todas as variáveis, funções e classes.
  2. Strings de Documentação: Utilize aspas triplas para strings multilinhas e inclua descrições dos parâmetros em português.
  3. Organização do Código: Agrupe configurações relacionadas e comente seções complexas do código para clareza.
  4. Tratamento de Erros: Adicione blocos try-except e mensagens de erro em português.
  5. Gerenciamento de Configurações: Utilize arquivos de configuração para ajustes específicos do ambiente e valide os parâmetros adequadamente.

Considerações Finais

As melhorias na documentação irão facilitar o acesso e a compreensão dos desenvolvedores de língua portuguesa, melhorando a adoção do CrewAI. As sugestões apresentadas devem ser incorporadas e revisadas antes da aceitação do pull request para garantir máxima efetividade e clareza.

Essas mudanças significativas devem ser adotadas para garantir que a documentação não apenas atenda, mas também supere as expectativas dos desenvolvedores da comunidade brasileira.


@irineub
Copy link
Contributor Author

irineub commented Jun 30, 2025

All code examples now use consistent Portuguese variable/function names, comments, and print statements.
Ensures 100% language consistency and clarity for Brazilian users.
Applies snake_case for variables, descriptive names, and triple quotes for long strings.

Copy link
Contributor

@lucasgomide lucasgomide left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sure your the Python variables name are valid

irineub added 2 commits July 1, 2025 10:35
…ithub.com:irineub/crewAI into fix/documentation-pt-br-code-examples-translation
@irineub
Copy link
Contributor Author

irineub commented Jul 1, 2025

Make sure your the Python variables name are valid

Ok I checked everything and fixed, if i need tô chance anything else please let me know , thanks

@irineub irineub requested a review from lucasgomide July 2, 2025 02:32
@irineub
Copy link
Contributor Author

irineub commented Jul 2, 2025

Hi @lucasgomide , thank you again for the review and approval! 🙌
Just checking in — is there anything else I should do on my end to move this PR forward, or is it ready to be merged?

Thanks in advance!

@lucasgomide lucasgomide merged commit 7f83947 into crewAIInc:main Jul 2, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants