Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Add `hexdoc_format` filter to wrap a literal string in FormatTree

Aberta Para iniciantes
  • Algo errado?
#90 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
72/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Procure na base de código onde os filtros Jinja são definidos, provavelmente em um módulo de templates. Encontre a classe FormatTree para entender seu construtor. Implemente o filtro hexdoc_format para envolver a string de entrada em uma instância de FormatTree, seguindo o padrão dos filtros existentes. Execute a suíte de testes do projeto para verificar a alteração.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement

Example use case:

bookofhexxy.welcome.content: "The $(l:{hex_book_url})Hex Casting book/$ can be viewed here, with content from several $(l:https://pypi.org/project/hexdoc/)hexdoc/$-compatible addons."

{# current workaround (produces a warning message) #}
{{ fmt.styled(_f(
  _("bookofhexxy.welcome.content").format(hex_book_url=hex_book_url)
)) }}

{# with this feature #}
{{ fmt.styled(hexdoc_format(
  _("bookofhexxy.welcome.content").format(hex_book_url=hex_book_url)
)) }}
Linguagem predominante
Python
Estrelas
7
Forks
10
Nenhum PR com merge em 30d

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de hexdoc-dev/hexdoc

Todas as issues de hexdoc-dev/hexdoc

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.