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

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

Aberta
#168 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 7 dias

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
55/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

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.

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

Descrição

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

Linguagem predominante
Python
Estrelas
3
Forks
1
Merge médio
6d 9min
PRs com merge (30d)
21

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.