NASA-AMMOS / aerie

A software framework for modeling spacecraft.
https://nasa-ammos.github.io/aerie-docs/
MIT License
73 stars 19 forks source link

Provide description metadata for resources and activity parameters #1474

Open parkerabercrombie opened 5 months ago

parkerabercrombie commented 5 months ago

Checked for duplicates

Yes - I've already checked

Alternatives considered

Yes - and alternatives don't suffice

Related problems

It should be easier for users to get information about activities and resources. Users may not have access to source code, and cross-referencing resources/params from Aerie to JavaDoc is cumbersome.

Describe the feature request

I want to be able to annotate resources and activity parameters with description information, similar to what we can do for units. Supposedly the metadata annotation capability should support this, but i have been unable to get it to work except for the unit case: https://jpl.slack.com/archives/C0163E42UBF/p1702073797959459