Incorrect Visordash use in documentation
维护者通常 7 天内回复
@ansBAkula 已经在做这个了。
开始于 2026年10月16日。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 85/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- python
调研方向
错误示例位于用户指南页面 'Use the VISOR Dash component' 的 'Launching VISOR' 部分,它将 label 和 value 传给了 Visordash。在文档源码中找到这段代码片段,并与错误信息中列出的可接受参数进行比较:aspectRatio, basePath, darkMode, fireSnapshot, host, id, parts, pixelDensity, port。当示例只使用可接受的参数,并且第 3 步中的 Dash 应用运行时不出现 TypeError,即为完成。
由索引模型根据 Issue 内容生成。
描述
🐞 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
- Go to the User Guide -> Lauch VISOR -> Use the VISOR Dash component page of the documentation.
- Follow the steps described on this page.
- When trying to follow step
3. Run the Dash app, execution should fail with a message of type :
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
- 主要语言
- Python
- 星标
- 3
- 派生
- 1
- 平均合并
- 6 天 14 小时
- 30 天内合并 PR
- 18
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
ansys/Visual-Interactive-Simulation-Object-Renderer 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
ansys/Visual-Interactive-Simulation-Object-Renderer#175 ·
维护者通常 7 天内回复
-
Apply button未关闭enhancement
难度 2/5 1-3 小时 新手友好度 68/100
ansys/Visual-Interactive-Simulation-Object-Renderer#157 ·
维护者通常 7 天内回复
-
visor-setup on macOS可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 85/100
ansys/Visual-Interactive-Simulation-Object-Renderer#148 ·
维护者通常 7 天内回复
-
VISOR viewer does not reconnect after shutting down and restarting a VISOR instance可能已有人在做 @ansBAkula 于 4 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 30/100
ansys/Visual-Interactive-Simulation-Object-Renderer#173 · 已指派 1 人 ·
维护者通常 7 天内回复
-
Interference with page layout in SAF可能已有人在做 @ansBAkula 于 4 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 25/100
ansys/Visual-Interactive-Simulation-Object-Renderer#172 · 已指派 1 人 ·
维护者通常 7 天内回复
查看 ansys/Visual-Interactive-Simulation-Object-Renderer 的全部 Issue
相似的 Issue
-
Uninstall guide omits the CloudWatch log groups AWS CodeBuild creates for useCodeBuild pipelines未关闭bug documentation
难度 1/5 1-3 小时 新手友好度 88/100
awslabs/visual-asset-management-system#552 ·
维护者通常 1 天内回复
-
netbox status: needs triage type: documentation
难度 1/5 1 小时以内 新手友好度 76/100
netbox-community/netbox#23460 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
awslabs/threat-composer#362 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
ansys/pyansys-common-mcp#213 ·
维护者通常 3 天内回复