Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add descriptions to label attributes exposed by LabelMeta #2

Open
LandingEllipse opened this issue Feb 2, 2022 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@LandingEllipse
Copy link
Contributor

While we'll eventually have dedicated documentation for EXM and PanCam label attributes a la NASA's HTML approach, it would arguably be valuable for application programmers if the attributes exposed via LabelMeta had some level of inline documentation. Partly to disambiguate the moniker to label path mappings, but also to lower the need for programmers to switch context (i.e., to the external docs) during development.

Ideally, the implementation would pull from a central source to avoid the maintenance burden of fragmented/duplicated documentation. Not immediately obvious how that would be achieved while remaining IM/DD/LDD version agnostic, though it could be argued that Proctools is implicitly tied anyway.

@LandingEllipse LandingEllipse added the documentation Improvements or additions to documentation label Feb 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant