Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte
#168 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 7 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
55/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
Active
Stack technique
python
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
Python
Étoiles
3
Forks
1
Merge moyen
6 j 14 h
PR mergées (30 j)
18

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ansys/Visual-Interactive-Simulation-Object-Renderer

Toutes les issues de ansys/Visual-Interactive-Simulation-Object-Renderer

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.