-
Notifications
You must be signed in to change notification settings - Fork 0
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
Replace all instances of BoM or Bom in class names with BOM #91
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One missing BOM, otherwise looks to do what it says on the tin.
I'm mostly 👎 to the change in general, but I do understand the logic following PEP-8
def create_definition(bom: str) -> BoM1711Definition: | ||
"""Instantiate and return a ``Bom1711Definition`` object based on the provided bom. | ||
def create_definition(bom: str) -> BOM1711Definition: | ||
"""Instantiate and return a ``BoM1711Definition`` object based on the provided BoM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missed a BOM here
I was trying to figure out when making this change if it's more or less readable than it was originally. I was also negative when making the change, but I put that down to my bias in having grown accustomed to the original class. I suppose the debate is whether 'BoM' is really an acronym in the same way that 'HTTP' is (the example used in PEP8). I know BoM is an acronym, but it's vocalized as 'bomb', and so you're more likely to expect to see it as a regularly-cased CapWord string. |
I'm erring on the side of rejecting this PR. My reasoning is as follows:
The current code is largely consistent with this. The one exception is in places where we refer to Granta-specific concepts such as 17/11 XML BoM formats, where we use the Granta capitalization of BoM. As a result, I'll close this PR and delete the branch. I'll create an Issue that refers to it, copy this conclusion there, and close it. |
This PR changes all instances of 'Bom' or 'BoM' in class names with 'BOM'.
This change is to ensure we are as compliant with PEP8 as is reasonable. Some considerations:
Bom1711...
,BomImpactedSubstances...
, etc. change toBOM1711...
,BOMImpactedSubstances...
, etc.ansys-grantami-bomanalytics-openapi
package capitalize the 'B' only, this is due to the way the code generator template generates Python class names and cannot be changed without a great deal of effortI did make a few changes to private docstrings, but these were just to standardize on 'BoM' when referring to the concept of a Bill of Materials, as opposed to 'bom'.