Skip to content

Fix descriptions for various #3528

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

Open
wants to merge 16 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ada79d4
Analytical_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
b3e85ef
BHoM_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
261a471
Data_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
e90d949
Environment_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
2752862
Facade_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
3942cd3
Geometry_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
e831fca
Graphics_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
86c863d
Library_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
f5b6ff7
Matter_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
3a4b3ed
Reflection_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
1215723
Serialiser_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
5bcccf0
Spatial_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
6701d30
Structure_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
1625379
Versioning_Engine: Fix XML documentation spelling and grammar errors
peterjamesnugent Jun 20, 2025
1215f8c
Add documentation punctuation
BHoMBot Jun 20, 2025
85bcd92
Reinstate whitespace changes and fix some headings
peterjamesnugent Jun 26, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Analytical_Engine/Modify/SetOutlineElements1D.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
[Input("edges", "A list of IElement1Ds which all should be of a type of Edge accepted by the Opening or Geometrical ICurve. \n" +
"ICurve will default the outlines properties.")]
[Output("opening", "The opening with updated Edges.")]
public static IOpening<TEdge> SetOutlineElements1D<TEdge>(this IOpening<TEdge> opening, IEnumerable<IElement1D> edges)

Check warning on line 48 in Analytical_Engine/Modify/SetOutlineElements1D.cs

View check run for this annotation

BHoMBot-CI / code-compliance

Analytical_Engine/Modify/SetOutlineElements1D.cs#L48

Modify methods should return void, or their return type should be different to the input type of their first parameter - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/ModifyReturnsDifferentType
where TEdge : IEdge
{
IOpening<TEdge> o = opening.ShallowClone();
Expand All @@ -61,7 +61,7 @@
[Input("edges", "A list of IElement1Ds which all should be of a type of Edge accepted by the IPanel or Geometrical ICurve. \n" +
"ICurve will default the outlines properties.")]
[Output("panel", "The IPanel with updated ExternalEdges.")]
public static IPanel<TEdge, TOpening> SetOutlineElements1D<TEdge, TOpening>(this IPanel<TEdge, TOpening> panel, IEnumerable<IElement1D> edges)

Check warning on line 64 in Analytical_Engine/Modify/SetOutlineElements1D.cs

View check run for this annotation

BHoMBot-CI / code-compliance

Analytical_Engine/Modify/SetOutlineElements1D.cs#L64

Modify methods should return void, or their return type should be different to the input type of their first parameter - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/ModifyReturnsDifferentType
where TEdge : IEdge
where TOpening : IOpening<TEdge>
{
Expand All @@ -73,11 +73,11 @@

/***************************************************/

[Description("Sets the Outline Element1Ds of an IRegion, i.e. the perimiter. Method required for all IElement2Ds.")]
[Description("Sets the Outline Element1Ds of an IRegion, i.e. the perimeter. Method required for all IElement2Ds.")]
[Input("region", "The IRegion to update the Perimeter of.")]
[Input("outlineElements", "A list of IElement1Ds which all should be Geometrical ICurves.")]
[Output("region", "The region with updated perimiter.")]
[Output("region", "The region with updated perimeter.")]
public static IRegion SetOutlineElements1D(this IRegion region, IEnumerable<IElement1D> outlineElements)

Check warning on line 80 in Analytical_Engine/Modify/SetOutlineElements1D.cs

View check run for this annotation

BHoMBot-CI / code-compliance

Analytical_Engine/Modify/SetOutlineElements1D.cs#L80

Modify methods should return void, or their return type should be different to the input type of their first parameter - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/ModifyReturnsDifferentType
{
if(region == null)
{
Expand Down
6 changes: 3 additions & 3 deletions Analytical_Engine/Query/Geometry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -184,17 +184,17 @@ public static Face Geometry(this IFace face)

/***************************************************/

[Description("Gets the geometry of a IRegion as its Perimiter curve. Method required for automatic display in UI packages.")]
[Description("Gets the geometry of a IRegion as its Perimeter curve. Method required for automatic display in UI packages.")]
[Input("region", "IRegion to get the curve geometry from.")]
[Output("curve", "The geometry of the IRegion as its Perimiter curve.")]
[Output("curve", "The geometry of the IRegion as its Perimeter curve.")]
public static ICurve Geometry(this IRegion region)
{
return region?.Perimeter;
}

/***************************************************/

[Description("Gets the geometry of a Graph as its relation curve arrows. For relations between entities of IElement0D types and outmatic curve is created if it does not exist. Method required for automatic display in UI packages.")]
[Description("Gets the geometry of a Graph as its relation curve arrows. For relations between entities of IElement0D types and automatic curve is created if it does not exist. Method required for automatic display in UI packages.")]
[Input("graph", "Graph to get the geometry from.")]
[Output("Composite Geometry", "The CompositeGeometry geometry of the Graph.")]
public static CompositeGeometry Geometry(this Graph graph)
Expand Down
2 changes: 1 addition & 1 deletion Analytical_Engine/Query/IsOutlineTrianglular.cs
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public static partial class Query
/***************************************************/

[Description("Determines whether a Panel's outline is triangular.")]
[Input("panel", "The IPanel to check if the outline is a triangular.")]
[Input("panel", "The IPanel to check if the outline is triangular.")]
[Output("bool", "True for Panels with a triangular outline or false for Panels with a non-triangular outline.")]
public static bool IsOutlineTriangular<TEdge, TOpening>(this IPanel<TEdge, TOpening> panel)
where TEdge : IEdge
Expand Down
4 changes: 2 additions & 2 deletions Analytical_Engine/Query/OutlineElements1D.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ public static List<IElement1D> OutlineElements1D<TEdge, TOpening>(this IPanel<TE

/***************************************************/

[Description("Gets the boundary from an IRegion defining the boundary of the element as the subparts of the perimiter curve. Method required for all IElement2Ds.")]
[Description("Gets the boundary from an IRegion defining the boundary of the element as the subparts of the perimeter curve. Method required for all IElement2Ds.")]
[Input("region", "The IRegion to get outline elements from.")]
[Output("elements", "Outline elements of the IRegion, i.e. the subparts of the Perimiter curve.")]
[Output("elements", "Outline elements of the IRegion, i.e. the subparts of the Perimeter curve.")]
public static List<IElement1D> OutlineElements1D(this IRegion region)
{
if(region == null)
Expand Down
12 changes: 6 additions & 6 deletions BHoM_Engine/Compute/RunExtensionMethod.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ public static partial class Compute
/**** Public Methods ****/
/***************************************************/

[Description("Runs an extension method accepting a single argument based on a provided object and method name.\n" +
[Description("Runs an extension method that accepts a single argument based on a provided object and method name.\n" +
"Finds the method via reflection the first time it is run, then compiles it to a function and stores it for subsequent calls.")]
[Input("target", "The object to find and run the extension method for.")]
[Input("methodName", "The name of the method to be run.")]
[Output("result", "The result of the method execution. If no method was found, null is returned.")]
[Output("result", "The result of the method execution. Returns null if no method was found.")]
public static object RunExtensionMethod(object target, string methodName)
{
if (TryRunExtensionMethod(target, methodName, out object result))
Expand All @@ -48,12 +48,12 @@ public static object RunExtensionMethod(object target, string methodName)

/***************************************************/

[Description("Runs an extension method accepting a multiple argument based on a provided main object and method name and additional arguments.\n" +
[Description("Runs an extension method that accepts multiple arguments based on a provided main object, method name and additional arguments.\n" +
"Finds the method via reflection the first time it is run, then compiles it to a function and stores it for subsequent calls.")]
[Input("target", "The first of the argument of the method to find and run the extention method for.")]
[Input("target", "The first argument of the method to find and run the extension method for.")]
[Input("methodName", "The name of the method to be run.")]
[Input("parameters", "The additional arguments of the call to the method, skipping the first argument provided by 'target'.")]
[Output("result", "The result of the method execution. If no method was found, null is returned.")]
[Input("parameters", "The additional arguments for the method call, excluding the first argument provided by 'target'.")]
[Output("result", "The result of the method execution. Returns null if no method was found.")]
public static object RunExtensionMethod(object target, string methodName, object[] parameters)
{
if(TryRunExtensionMethod(target, methodName, parameters, out object result))
Expand Down
6 changes: 3 additions & 3 deletions BHoM_Engine/Compute/TryRunExtensionMethod.cs
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ public static bool TryRunExtensionMethod(this object obj, string methodName, out

/***************************************************/

[Description("Looks for an extension method applicable to the input object with the provided `methodName` and and, if found, invokes it.\n" +
[Description("Looks for an extension method applicable to the input object with the provided `methodName` and, if found, invokes it.\n" +
"Extension methods are searched using Reflection through all BHoM assemblies.\n" +
"If no method is found, this returns `false`, and the `result` is null.")]
[Input("obj", "Object whose extension method is to be found, and to which the method will be applied in order to obtain the result.")]
[Input("methodName", "Name of the extension method defined for the input object that is to be found in any of the BHoM assemblies.")]
[Input("parameters", "The additional arguments of the call to the method, skipping the first argument provided by 'target'.")]
[Input("parameters", "The additional arguments for the method call, excluding the first argument provided by 'obj'.")]
[Input("result", "Result of the method invocation, if the method had been invoked. If no method is found this is null.")]
[Output("True if a method was found and an invocation was attempted. False otherwise.")]
public static bool TryRunExtensionMethod(this object obj, string methodName, object[] parameters, out object result)
Expand All @@ -81,7 +81,7 @@ public static async Task<Output<bool, object>> TryRunExtensionMethodAsync(this o

/***************************************************/

[Description("Looks for an extension method applicable to the input object with the provided `methodName` and and, if found, invokes it asynchronously.\n" +
[Description("Looks for an extension method applicable to the input object with the provided `methodName` and, if found, invokes it asynchronously.\n" +
"Extension methods are searched using Reflection through all BHoM assemblies.\n" +
"If no method is found, this returns `false`, and the `result` is null.")]
[Input("obj", "Object whose extension method is to be found, and to which the method will be applied in order to obtain the result.")]
Expand Down
34 changes: 17 additions & 17 deletions BHoM_Engine/Query/ExtensionMethodToCall.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,24 @@ public static partial class Query
/**** Public Methods ****/
/***************************************************/

[Description("Finds an extension method accepting a multiple argument based on a provided main object and method name.\n" +
"The method is found via reflection at the first time it is queried, then it is stored for subsequent calls.")]
[Input("target", "First argument of the method to find.")]
[Description("Finds an extension method that accepts multiple arguments based on a provided main object and method name.\n" +
"The method is found via reflection the first time it is queried, then it is stored for subsequent calls.")]
[Input("target", "The first argument of the method to find.")]
[Input("methodName", "The name of the method to be sought.")]
[Output("method", "Most suitable extension method with requested target, name and parameters. If no method was found, null is returned.")]
[Output("method", "The most suitable extension method with the requested target, name and parameters. Returns null if no method was found.")]
public static MethodInfo ExtensionMethodToCall(this object target, string methodName)
{
return ExtensionMethodToCall(methodName, new object[] { target });
}

/***************************************************/

[Description("Finds an extension method accepting a multiple argument based on a provided main object and method name and additional arguments.\n" +
"The method is found via reflection at the first time it is queried, then it is stored for subsequent calls.")]
[Input("target", "First argument of the method to find.")]
[Description("Finds an extension method that accepts multiple arguments based on a provided main object, method name and additional arguments.\n" +
"The method is found via reflection the first time it is queried, then it is stored for subsequent calls.")]
[Input("target", "The first argument of the method to find.")]
[Input("methodName", "The name of the method to be sought.")]
[Input("parameters", "The additional arguments of the call to the method, skipping the first argument provided by 'target'.")]
[Output("method", "Most suitable extension method with requested target, name and parameters. If no method was found, null is returned.")]
[Input("parameters", "The additional arguments for the method call, excluding the first argument provided by 'target'.")]
[Output("method", "The most suitable extension method with the requested target, name and parameters. Returns null if no method was found.")]
public static MethodInfo ExtensionMethodToCall(this object target, string methodName, object[] parameters)
{
return ExtensionMethodToCall(methodName, new object[] { target }.Concat(parameters).ToArray());
Expand All @@ -62,12 +62,12 @@ public static MethodInfo ExtensionMethodToCall(this object target, string method

/***************************************************/

[Description("Method doing the heavy lifting of ExtensionMethodToCall. Finds the matching method via reflection and caches if for subsequent calls.\n" +
"Finds an extension method accepting multiple arguments with extra emphasis on the first argument in terms of type matching.\n" +
"Method found can have more arguments than the provided parameters, if all of those additional arguments have default values.")]
[Description("Performs the core functionality of ExtensionMethodToCall. Finds the matching method via reflection and caches it for subsequent calls.\n" +
"Finds an extension method that accepts multiple arguments with extra emphasis on the first argument in terms of type matching.\n" +
"The method found can have more arguments than the provided parameters, if all of those additional arguments have default values.")]
[Input("methodName", "The name of the method to be sought.")]
[Input("parameters", "The arguments of the call to the method.")]
[Output("method", "Most suitable extension method with requested name and parameters. If no method was found, null is returned.")]
[Input("parameters", "The arguments for the method call.")]
[Output("method", "The most suitable extension method with the requested name and parameters. Returns null if no method was found.")]
public static MethodInfo ExtensionMethodToCall(string methodName, object[] parameters)
{
if (parameters == null || parameters.Length == 0 || parameters[0] == null)
Expand Down Expand Up @@ -158,7 +158,7 @@ private static bool IsApplicable(this MethodInfo method, object[] parameters)

/***************************************************/

[Description("Checks if an entry with the provided key has already been extracted. Put in its own method to simplify the use of locks to provide thread safety.")]
[Description("Checks if an entry with the provided key has already been extracted. This method is separated to simplify the use of locks for thread safety.")]
private static bool MethodPreviouslyExtracted(Tuple<Type, string> key)
{
lock (m_ExtensionMethodToCallLock)
Expand All @@ -169,7 +169,7 @@ private static bool MethodPreviouslyExtracted(Tuple<Type, string> key)

/***************************************************/

[Description("Gets a previously extracted method from the stored methods. Put in its own method to simplify the use of locks to provide thread safety.")]
[Description("Retrieves a previously extracted method from the stored methods. This method is separated to simplify the use of locks for thread safety.")]
private static MethodInfo GetStoredExtensionMethod(Tuple<Type, string> key)
{
lock (m_ExtensionMethodToCallLock)
Expand All @@ -180,7 +180,7 @@ private static MethodInfo GetStoredExtensionMethod(Tuple<Type, string> key)

/***************************************************/

[Description("Stores an extracted method. Put in its own method to simplify the use of locks to provide thread safety.")]
[Description("Stores an extracted method for future use. This method is separated to simplify the use of locks for thread safety.")]
private static void StoreExtensionMethod(Tuple<Type, string> key, MethodInfo method)
{
lock (m_ExtensionMethodToCallLock)
Expand Down
8 changes: 4 additions & 4 deletions Data_Engine/Create/Node.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ public static partial class Create
"i.e. The data will be stored in the leaves and the parent node can be defined through its children.")]
[Input("dataItems", "The data to store in the Node tree, formatted as leaf nodes.")]
[Input("splitDataMethod", "Method clustering a collection of leaves into two collections based on their data.")]
[Input("setChildrenToNode", "Method which creates a parent node of the provided nodes and assignes them as children. " +
"Called last, any data assigned within to the parent will be avalible for use on the children it operates on due to recursion.")]
[Input("setChildrenToNode", "Method which creates a parent node of the provided nodes and assigns them as children. " +
"Called last, any data assigned within to the parent will be available for use on the children it operates on due to recursion.")]
[Input("treeDegree", "The number of child nodes for each node.")]
[Input("leafSize", "The number of siblings a leaf node can have.")]
[Output("node", "Root node for a data tree with all the data in its leaves and with nodes defined by their children.")]
Expand Down Expand Up @@ -97,8 +97,8 @@ public static TNode Node<TNode, T>(IEnumerable<TNode> dataItems,
[Input("dataItems", "The data to store in the Node tree, formatted as leaf nodes.")]
[Input("partitionMethod", "Method to separate a flat collection of data into the data collections for the child nodes. " +
"Number of collections returned will be the degree of the tree. Breaks the recursion when it only returns a single collection.")]
[Input("setChildrenToNode", "Method which creates a parent node of the provided nodes and assignes them. " +
"Called last, any data assigned within to the parent will be avalible for use on the children it operates on due to recursion.")]
[Input("setChildrenToNode", "Method which creates a parent node of the provided nodes and assigns them. " +
"Called last, any data assigned within to the parent will be available for use on the children it operates on due to recursion.")]
[Input("leafSize", "The number of siblings a leaf node can have.")]
[Output("node", "Root node for a data tree with all the data in its leaves and with nodes defined by their children.")]
public static TNode Node<TNode, T>(IEnumerable<TNode> dataItems,
Expand Down
2 changes: 1 addition & 1 deletion Data_Engine/Query/ValuesAbove.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@
/**** Public Methods ****/
/***************************************************/

[Description("Gets all table rows with values exeeding the values provided. Values returned as CustomObjects")]
[Description("Gets all table rows with values exceeding the values provided. Values returned as CustomObjects")]

Check warning on line 39 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L39

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("table", "The table to extract values from")]

Check warning on line 40 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L40

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("axes", "The axis of the table to match values for")]

Check warning on line 41 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L41

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("values", "The value of the axis to match with")]

Check warning on line 42 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L42

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("allowEqual", "Sets whether exact matching values are allowed or not")]

Check warning on line 43 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L43

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Output("Data", "The data matching the provided axes and values as CustomObjects.")]
public static List<CustomObject> ValuesAbove(this Table table, List<string> axes, List<object> values, bool allowEqual = true)
{
Expand All @@ -58,12 +58,12 @@

/***************************************************/

[Description("Gets all table rows with values exeeding the values provided sorted by the sortAxis. Values returned as CustomObjects")]

Check warning on line 61 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L61

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("table", "The table to extract values from")]

Check warning on line 62 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L62

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("axes", "The axis of the table to match values for")]

Check warning on line 63 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L63

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("values", "The value of the axis to match with")]

Check warning on line 64 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L64

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Input("sortAxis", "The axis the values should be sorted by.")]
[Input("allowEqual", "Sets whether exact matching values are allowed or not")]

Check warning on line 66 in Data_Engine/Query/ValuesAbove.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Data_Engine/Query/ValuesAbove.cs#L66

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Output("Data", "The data matching the provided axes and values as CustomObjects.")]
public static List<CustomObject> ValuesAbove(this Table table, List<string> axes, List<object> values, string sortAxis, bool allowEqual = true)
{
Expand Down
4 changes: 2 additions & 2 deletions Environment_Engine/Compute/ThirdOrderPolynomial.cs
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@
/**** Public Methods ****/
/***************************************************/

[Description("Calculate the Third Order Polynominal for the numbers provided. The equation is: ((a * x + b) * x * c) * x + d")]
[Output("thirdOrderPolynominal", "The calculated Third Order Polynominal")]
[Description("Calculate the Third Order Polynomial for the numbers provided. The equation is: ((a * x + b) * x + c) * x + d")]

Check warning on line 45 in Environment_Engine/Compute/ThirdOrderPolynomial.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Environment_Engine/Compute/ThirdOrderPolynomial.cs#L45

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
[Output("thirdOrderPolynomial", "The calculated Third Order Polynomial")]

Check warning on line 46 in Environment_Engine/Compute/ThirdOrderPolynomial.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Environment_Engine/Compute/ThirdOrderPolynomial.cs#L46

Documentation attribute should end with grammatically correct punctuation (., !, or ?) - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/AttributeHasEndingPunctuation
public static double ThirdOrderPolynomial(double a, double b, double c, double d, double x)

Check warning on line 47 in Environment_Engine/Compute/ThirdOrderPolynomial.cs

View check run for this annotation

BHoMBot-CI / documentation-compliance

Environment_Engine/Compute/ThirdOrderPolynomial.cs#L47

Input parameter requires a matching Input attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/IsInputAttributePresent Input parameter requires a matching Input attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/IsInputAttributePresent Input parameter requires a matching Input attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/IsInputAttributePresent Input parameter requires a matching Input attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/IsInputAttributePresent Input parameter requires a matching Input attribute - For more information see https://bhom.xyz/documentation/DevOps/Code%20Compliance%20and%20CI/Compliance%20Checks/IsInputAttributePresent
{
return ((a * x + b) * x + c) * x + d;
}
Expand Down
Loading