Sp-dev-docs: Naming of IPropertyPaneFieldType

Created on 21 Aug 2016  路  6Comments  路  Source: SharePoint/sp-dev-docs

Is IPropertyPaneFieldType really the correct naming for that enumeration? Normally I is used to show that it is an intererface. I recommend renaming it to PropertyPaneFieldType.

spfx-general tracked bug-suspected

All 6 comments

I understand your concern @wictorwilen. We had a big debate over the naming of interfaces. The confusion comes from the fact that TypeScript does not have a separate annotation for typing javascript objects. Interfaces are used for both Class interfaces and javascript object typing. Eventually, we agreed to the current convention.

I don't get it. This is not an interface, it's an enumeration, that's why it should not be prefixed with an I. Just because it all transpiles down to JavaScript doesn't mean we(you) should ignore all known naming conventions?

Following up on this. This wasn't intended, and will get fixed up. We do occasionally use I* naming, but as you say, that should only be for scenarios where they act like traditional interfaces, not an artifact of what you can do in TS/JS. Thanks for pointing it out.

VSO 239932

Cleaning up closed issues.

Issues that have been closed & had no follow-up activity for at least 7 days are automatically locked. Please refer to our wiki for more details, including how to remediate this action if you feel this was done prematurely or in error: Issue List: Our approach to locked issues

Was this page helpful?
0 / 5 - 0 ratings

Related issues

mikeparkie picture mikeparkie  路  3Comments

byrongits picture byrongits  路  3Comments

ken-harris picture ken-harris  路  3Comments

waldekmastykarz picture waldekmastykarz  路  3Comments

qrown picture qrown  路  3Comments