Skip to content
This repository has been archived by the owner on Oct 2, 2020. It is now read-only.

Update metadatacheck to fit v5.1 #312

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

poeschlr
Copy link
Collaborator

@poeschlr poeschlr commented Oct 6, 2019

if self.checkDocumentation(alias, self.component.aliases[alias], True, self.component.isGraphicSymbol() or self.component.isPowerSymbol()):
invalid_documentation += 1

return invalid_documentation > 0
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No real reason to keep a counter since the result ultimately goes to a Boolean. But I guess in the future it could be handy and it works now too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All other scripts use counters

@evanshultz
Copy link
Collaborator

I assume at KiCad/kicad-website#446 (comment) you are referring to this script update?

check_lib_file requires at least four pieces of documentation in the lib file. Isn't that wrong? Don't we want F4 to always be blank, and we also accept F3 to be blank for generic symbols that only have a bunch of FP filters? Maybe I didn't quite understand this.

@poeschlr
Copy link
Collaborator Author

poeschlr commented Jan 20, 2020

I now ran the new script and old script on the current master branch of the symbol lib (Limited to the rules that i changed). There is not really a difference in the reports other than what is expected from combining the rules (S6.3 changed to S6.2, detailed messages changed and if both s6.3 and S6.2 is violated then they are of course under the same header which makes diff think something was added in the original)
The logs i created in this process:
before_change_1.txt
after_change_1.txt

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants