Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Incorrect Visordash use in documentation

Aberta Para iniciantes
  • Algo errado?
#174 0 comentários 0 reações 1 responsável Ver no GitHub

Mantenedores costumam responder em até 7 dias

@ansBAkula já está trabalhando nisso.

Desde 16/10/2026.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
85/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

O exemplo ruim está na página do guia do usuário 'Use the VISOR Dash component', em 'Launching VISOR', e passa label e value para Visordash. Encontre esse trecho no código-fonte da documentação e compare-o com os argumentos aceitos listados na mensagem de erro: aspectRatio, basePath, darkMode, fireSnapshot, host, id, parts, pixelDensity, port. Está pronto quando o exemplo usa apenas argumentos aceitos e o app Dash da etapa 3 roda sem um TypeError.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

🐞 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
Linguagem predominante
Python
Estrelas
3
Forks
1
Merge médio
6d 14h
PRs com merge (30d)
18

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de ansys/Visual-Interactive-Simulation-Object-Renderer

Todas as issues de ansys/Visual-Interactive-Simulation-Object-Renderer

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.