Ch5 first import is confusing

Offen Anfängerfreundlich
#191 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
85/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
documentation

Rechercherichtung

Suche die Inhaltsdatei des Importabschnitts von Kapitel 5 im Repository der lc-python-intro Lektion. Aktualisiere die erklärende Zeile, um library_name.function durch library_name.object zu ersetzen, und ersetze das erste Codebeispiel durch den vorgeschlagenen Schnipsel, der sowohl einen Funktionsaufruf (string.capwords) als auch die Verwendung eines importierten String-Objekts (string.ascii_lowercase) demonstriert. Zeige eine Vorschau der erstellten Lektion an, um zu bestätigen, dass die Änderung wie beabsichtigt angezeigt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

How could the content be improved?

At the start of Ch5 "You must import a library or module before using it"

Use import to load a library into a program’s memory. Then you can refer to things from the library as library_name.function

Then the first thing you load in is string.ascii_lowercase which is not a function, it is a string!

Suggestion on how to resolve it:
Edit the text above so it is more general: "Then you can refer to things from the library as library_name.object"

Then have the code box be something like:

import string

# Using an imported function
print(string.capwords('capitalise this sentence please.'))
# Imported objects can also be strings, numbers, or other types of objects
print(f'The lower ascii letters are {string.ascii_lowercase}')
Which part of the content does your suggestion apply to?

Ch5 You must import a library or module before using it

Vorherrschende Sprache
HTML
Sterne
25
Forks
65
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

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 LibraryCarpentry/lc-python-intro

Alle Issues in LibraryCarpentry/lc-python-intro

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

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