Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở
#168 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 7 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Python
Star
3
Fork
1
Merge trung bình
6 ngày 9 phút
Pull request đã merge (30 ngày)
21

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ansys/Visual-Interactive-Simulation-Object-Renderer

Tất cả issue của ansys/Visual-Interactive-Simulation-Object-Renderer

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.