Indexing needs improvement throughout

Aberta
#131 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

No file or test is named. Start by locating the book's index source and existing uses of the tags, then review how concepts, code terms, capitalization, and acronyms are currently indexed. Done means the index follows all four stated rules throughout the book.

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

Descrição

Indices should:

  1. Serve as a reference for all important concepts and code terminology.
  2. All code such as while should be placed in the index as <idx><c>while</c></idx>. Of course, you cannot see anything that is between <idx> tags, so indexing is best done at the beginning of a sentence or paragraph.
  3. ONLY be capitalized if a proper noun or an acronym or code that must be capitalized. e.g. object-oriented programming should NOT be capitalized in the index
  4. Acronyms should appear in the index separately from what they stand for. e.g., OOP and object-oriented programming should be indexed separately.
Linguagem predominante
Python
Estrelas
28
Forks
42
Nenhum PR com merge em 30d

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

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 RunestoneInteractive/java4python

Todas as issues de RunestoneInteractive/java4python

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.