-
Notifications
You must be signed in to change notification settings - Fork 15
IsValidConvertMethodName
Severity - Fail
Check method - Here
The IsValidConvertMethodName
check ensures that Convert
class methods are named correctly based on the guidance for BHoM development.
The guidance, at the time of writing, states that Convert
methods should go To
their external software, and From
their external software, rather than ToBHoM
or FromBHoM
.
For example, this Convert
method will fail:
public static Span ToBHoM()
While this one will pass:
public static Span ToSoftware()
Although not a strict requirement, it is advised that convert method names reflect the software that the convert is going to
or from
. This helps make it clear what the external object model is and helps inform users of what to expect when using the convert method.
-
Introduction to the BHoM:
What is the BHoM for?
Structure of the BHoM
Technical Philosophy of the BHoM -
Getting Started:
Installing the BHoM
Using the BHoM
Submitting an Issue
Getting started for developers -
Use GitHub & Visual Studio:
Using the SCRUM Board
Resolving an Issue
Avoiding Conflicts
Creating a new Repository
Using Visual Studio
Using Visual Studio Code -
Contribute:
The oM
The Engine
The Adapter
The Toolkit
The UI
The Tests -
Guidelines:
Unit convention
Geometry
BHoM_Engine Classes
The IImmutable Interface
Handling Exceptional Events
BHoM Structural Conventions
BHoM View Quality Conventions
Code Versioning
Wiki Style
Coding Style
Null Handling
Code Attributes
Creating Icons
Changelog
Releases and Versioning
Open Sourcing Procedure
Dataset guidelines -
Foundational Interfaces:
IElement Required Extension Methods -
Continuous Integration:
Introduction
Check-PR-Builds
Check-Core
Check-Installer -
Code Compliance:
Compliance -
Further Reading:
FAQ
Structural Adapters
Mongo_Toolkit
Socket_Toolkit