matplotlib / matplotlib/cheatsheets

Variable names should generally be lowercase

Offen
#65 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
7.7k
Forks
916
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

In many places we have uppercase variables, e.g.

X = np.linspace(0, 2 * np.pi, 100)
Y = np.sin(X)

and likewise then in the plot functions.

This is against PEP-8 naming conventions and IMHO sets a bad example. At least 1D arrays should be lowercase. One may debate on 2D arrays, which have a history of using uppercase letters in the Matplotlib docs.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Durchsuche die Cheatsheets nach Beispielen, in denen Großbuchstabenvariablen wie X und Y verwendet werden, einschließlich der zugehörigen Plot-Funktionen. Prüfe die umgebenden Matplotlib-Beispiele und die Benennungsrichtlinien von PEP-8 und aktualisiere dann die Namen der 1D-Arrays; entscheide dabei, ob die dokumentierte Konvention für 2D-Arrays beibehalten werden sollte; als erledigt gilt die Aufgabe, wenn die betroffenen Beispiele die gewählte Konvention durchgängig widerspiegeln.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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