Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Incorrect Visordash use in documentation

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#174 0 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

Maintainer antworten meist innerhalb von 7 Tagen

@ansBAkula arbeitet bereits daran.

Seit 16.10.2026.

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

Das schlechte Beispiel steht auf der User-Guide-Seite 'Use the VISOR Dash component' unter 'Launching VISOR' und übergibt label und value an Visordash. Finde dieses Snippet im Quellcode der Dokumentation und vergleiche es mit den akzeptierten Argumenten aus der Fehlermeldung: aspectRatio, basePath, darkMode, fireSnapshot, host, id, parts, pixelDensity, port. Fertig ist es, wenn das Beispiel nur akzeptierte Argumente verwendet und die Dash-App in Schritt 3 ohne TypeError läuft.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

🐞 Description of the bug

In the User Guide explaining how to use the VISOR Dash component, the arguments of Visordash lead to a bug.

The exemple is as follows :

td = Visordash(
    id="input",
    value="my-value",
    label="my-label",
    host="localhost",
    port=VISOR_PORT,
)

However, the list of accepted arguments according to the error message is :

aspectRatio
basePath
darkMode
fireSnaphot
host
id
parts
pixelDensity
port

label and value are not valid. The documentation requires an update to understand better what arguments won't lead to a fail at run time.

📝 Steps to reproduce
TypeError: The `visordash.Visordash` component (version 0.0.1) with the ID "input" received an unexpected keyword argument: `label`
Allowed arguments: aspectRatio, basePath, darkMode, fireSnapshot, host, id, parts, pixelDensity, port
📦 Installed packages and configuration

OS : Windows 11

VISOR 1.0.1

🚦 Defines the severity of the bug. In the case of class-3, specific information must be added.

Class 2 - Serious problem

📦 Support ticket ID

No response

🐞 Found in

No response

🩹 Fixed in

No response

Root cause

User Guide documentation leads to the issue.

Third Party
  • This bug is introduced by a third party
Released Bug
  • This bug is in a released product
Vorherrschende Sprache
Python
Sterne
3
Forks
1
Ø Merge
6 T. 14 Std.
Gemergte PRs (30 T.)
18

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 ansys/Visual-Interactive-Simulation-Object-Renderer

Alle Issues in ansys/Visual-Interactive-Simulation-Object-Renderer

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

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