Skip to content
New issue

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

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

Already on GitHub? # to your account

Proposal for fixed attribute types and "long names" #692

Open
mumbricht opened this issue Mar 7, 2025 · 0 comments
Open

Proposal for fixed attribute types and "long names" #692

mumbricht opened this issue Mar 7, 2025 · 0 comments

Comments

@mumbricht
Copy link

This is related to issue #646

ReqIF requires fixed types for attributes. This makes sense, as a particular attribute should describe the same thing across items. For example, given a "tested" attribute, it is not appropriate to switch from bool (False) to date (date of test). A new "test_date" attribute should be created which is empty if "tested" is false. Or any of a number of other logical implementations.

I propose that in the .doorstop.yml document a second and third dict attribute called default_types and default_long_names in order to store this data and permit for error checking and tooltips respectively. The keys would match the keys for defaults

I have written get_or_gen() function for ReqIF functionality which can be used to populate these dicts automatically or by prompt. Tests are in core/tests/test_editor.py.

I would appreciate feedback, since this is a pretty deep change to the document structure. In the meantime, I can guess at the datatypes and throw in case of inconsistency. This is going to make issues though, since .yml is known to make unexpected typing decisions.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant