Indexing needs improvement throughout

Offen
#131 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
Python
Sterne
28
Forks
42
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus RunestoneInteractive/java4python

Alle Issues in RunestoneInteractive/java4python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.