python / python/devguide

Documenting minimizing diffs for ease of review

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

Ninguém assumiu esta issue ainda.

needs: decision type-feature
Linguagem predominante
Python
Estrelas
2.1k
Forks
1k
Merge médio
2d 12h
PRs com merge (30d)
12

Descrição

Suppose we have some lines that are close to 80 chars long

first text ... end first text.
second text ... end second text.
third text ... end third text.

and if the first line needs some sort of modification that would push it past 80 chars, we can either restructure the entire paragraph of raw rst so it looks tidier, but resulting in 4 lines of git diffs

first text plus some more ...
end first text. second text ...
end second text. third text ...
end third text.

or diffs can be minimized (but with an 'uglier' raw rst), such as like

first text plus some more ...
... end first text.
second text ... end second text.
third text ... end third text.

I think that for ease of reviewing, as well as to maintain a more useful git history, that the second is preferred in general but I haven't found it in the style guide, so maybe it can be added there if there's consensus on it?

Guia de contribuição

Abrir o guia de contribuição

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.

Direção de pesquisa

Leia o guia de estilo da documentação vinculado na issue e revise a discussão existente sobre a minimização de diffs. Adicione orientações somente se o projeto concordar com essa preferência, incluindo exemplos que mostrem o estilo de quebra de linha recomendado; o guia de estilo deve documentar claramente a convenção quando isso estiver concluído.

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

Avaliação

Stack de tecnologia
python
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

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