LukeMathWalker / LukeMathWalker/rustdoc-reflection

Relation to nightly Rust

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

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Rust
Sterne
3
Forks
0
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Thanks for building these crates! I am tempted to experiment with them, most likely in PyO3's CI initially - we have a [`pyo3-ffi-check`](https://github.com/PyO3/pyo3/tree/20246a895718baa603f836b187b498cedc6941ca/pyo3-ffi-check) helper which compares our hand-maintained FFI to bindgen (because reasons).

Currently has a ton of hacks where I build docs html and parse that, which is painful plus has shortcomings like case-insensitive filesystems meaning I can't easily check the difference between e.g. `Py_INCREF` and `Py_IncRef` symbols.

I understand that the rustdoc JSON is still not stable. Do these crates automate the process of pinning / selecting the right nightly toolchain to get "stable" rustdoc JSON processing?

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

Beginne mit dem im Issue verlinkten pyo3-ffi-check-Helfer und prüfe, wie er derzeit von generiertem Dokumentations-HTML abhängt. Untersuche anschließend das rustdoc JSON der Crates und die nightly-toolchain-Einstiegspunkte, um festzustellen, ob das Anheften oder Auswählen eines kompatiblen Nightly unterstützt wird. Als abgeschlossen gilt die Dokumentation der aktuellen Fähigkeit und, falls sie fehlt, die Definition des erforderlichen Automatisierungs- und Kompatibilitätsverhaltens.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rust
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Ruhig
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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