Canonicalization for 're'-inherited methods

Offen

#60 erstellt am 27.3.2021 4 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: 35/100

Issue-Typ: Dokumentation
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Bereich: documentation

Rechercherichtung

Beginne damit, das Redirect-/Kanonisierungs-Skript zu finden, und vergleiche dessen Behandlung der geerbten Artist-Methoden mit den von Sphinx generierten Verweisen. Prüfe, wie die Axes-Methoden nach der Entfernung der Dokumentation in 3.4.0 dargestellt werden. Erledigt ist dies, wenn das Skript diese Methoden auf ihren aktuellen kanonischen Ort verweist oder eindeutig festhält, dass dies nicht möglich ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

In 3.4.0, the docs for some Axes methods (pick, pickable, get_picker, set_picker, get_contains, set_contains) were removed. This is because the docs are inherited from the Artist methods.

Sphinx automatically switches all references when generated the docs, but our redirect/canonicalization script here doesn't recognize it. Instead, it thinks these methods were last documented in 3.3.4 and points there.

We should decide if we want to point to the new location (and figure out if it's possible), and do so.

Vorherrschende Sprache: Keine Sprachdaten
Sterne: 29
Forks: 62
PR-Merge-Kennzahlen: Keine gemergten PRs in 30 T.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

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