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

Allow redefinition of formal-name and description in flag, field, and assembly references #194

Closed
1 of 4 tasks
david-waltermire opened this issue Mar 17, 2022 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@david-waltermire
Copy link
Collaborator

david-waltermire commented Mar 17, 2022

User Story:

As a Metaschema-based model author, I want to override the formal-name and/or description in a flag, field, or assembly reference to reflect more fine-grained naming and semantics for where a definition is (re)-used as compared to where it is defined.

This feature will allow generated documentation to better reflect the local semantics at the point of definition use.

Issue usnistgov/OSCAL#1129 and PR usnistgov/OSCAL#1171 are related examples of where this can be used.

Goals:

Dependencies:

None.

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@david-waltermire
Copy link
Collaborator Author

david-waltermire commented Feb 7, 2023

The metaschema schema has been modified to support this for assembliy, field, and flag references.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants