improving the Searcher JS module

Aberta
#1,207 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
45/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
javascript
Domínio
search

Direção de pesquisa

Comece lendo lib/rdoc/generator/template/json_index/js/searcher.js e compare o comportamento atual da pesquisa de texto completo e do realce com a abordagem proposta usando Fuse.js. Identifique casos de teste adequados do RDoc ou exemplos do mundo real; em seguida, verifique se a nova implementação mantém ou melhora o comportamento existente e se esses casos passam.

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

Descrição

enhancement

Hello, I'd like to propose a change to the Searcher.js module at lib/rdoc/generator/template/json_index/js/searcher.js, to have this switch to using Fuse.js for its full text searching and highlighting capabilities. That part I can handle in a PR.

What part I got stuck on was how to test that this new implementation would be working as well (or, ideally, better) than the previous one. Are there some test cases that this should be passing within the RDoc project itself or some real-world cases that I could try out?

Linguagem predominante
Ruby
Estrelas
928
Forks
471
Merge médio
2d 4min
PRs com merge (30d)
13

Preparar o ambiente

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 ruby/rdoc

Todas as issues de ruby/rdoc

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

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