Documenting minimizing diffs for ease of review
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 2.1k
- Forks
- 1k
- Ø Merge
- 2 T. 12 Std.
- Gemergte PRs (30 T.)
- 12
Beschreibung
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?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Lies den im Issue verlinkten Dokumentations-Styleguide und prüfe die bestehende Diskussion zur Minimierung von Diffs. Füge nur dann eine Anleitung hinzu, wenn sich das Projekt auf diese Präferenz einigt, und zeige anhand von Beispielen den empfohlenen Umbruchstil; der Styleguide sollte die Konvention anschließend klar dokumentieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100