Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[User Story]: Improve documentation for setting Metadata in VISOR

未关闭
#168 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 7 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
documentation

调研方向

The issue names the Metadata class in VISOR, which is a Python project, but does not name the file or the docs page. Find the Metadata class definition and the current documentation page that shows simple Metadata examples, then list every field the class accepts. Done means the documentation gains an authoritative reference covering all supported fields, with an example.

由索引模型根据 Issue 内容生成。

描述

User Story Description

As a user of VISOR I would like to know how to leverage the Metadata class/file to include metadata for my datasets.

The documentation shows simple examples, but does not provide reference for the full set of parameters supported by the Metadata class.

Acceptance Criteria

Metadata documentation - and example - includes an authoritative reference for all supported fields.

Additional Links

No response

Requires new or update to third party ? If "yes" add the name(s) and the version(s) of the Third Party Software.

No

Name and Version for Third Parties

No response

主要语言
Python
星标
3
派生
1
平均合并
6 天 9 分钟
30 天内合并 PR
21

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ansys/Visual-Interactive-Simulation-Object-Renderer 的其他 Issue

查看 ansys/Visual-Interactive-Simulation-Object-Renderer 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。