dwavesystems / dwavesystems/dwave-preprocessing
Composites show as being under the __init__ module
- Vorherrschende Sprache
- C++
- Sterne
- 9
- Forks
- 18
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
The [built docs](https://docs.dwavequantum.com/en/latest/ocean/api_ref_preprocessing/api_ref.html) show currently like this:
This is due to the placement of the ``.. automodule:: dwave.preprocessing.composites.__init__`` directive, and it causes a problem for xrefing:
The ``objects.inv`` looks like this:
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Finde die Dokumentationsquelle, die die Direktive `.. automodule:: dwave.preprocessing.composites.__init__` enthält, und untersuche, wie die Composites dargestellt werden. Baue die betroffene API-Dokumentation neu auf und überprüfe, dass die Composites unter dem vorgesehenen Modul erscheinen und dass die generierte `objects.inv` die erwarteten Querverweise unterstützt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100