Register description is not mandatory #25
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
However, the python code was failing when there is no description. To avoid having to catch at a lot of places in the Python code where there is no variable reg.desc, I assign an empty string during the parsing step if not description XML element is there. I've modified the test input to have one without description. Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com>
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi Andreas,
I had a register without description and the python code failed on it.
The XML itself was valid. A description of a registers seems to be not needed in IP-XACT.
I've modified one of your test registers so it does not have a description.
And modified the Python code if there is no description element, it will add an empty string as description.
This makes it a bit easier to maintain the code. And I prefer having a 'Description:' line in the documentation so that
it's clear it's better to add a description.
Thanks for reviewing.