1
0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-10 04:55:42 +00:00
X10D/.github/ISSUE_TEMPLATE/extension-method-request.md
2020-04-19 15:10:29 +01:00

1.6 KiB

name about title labels assignees
Extension method request Make a request for an extension method you believe should be implemented enhancement oliverbooth

Type Provide the fully-qualified type name of the extension method you wish to have here. Example:

System.String

Extension method signature Provide the full method signature here, without parameter names, but do not include the leading this T x parameter. Example:

string Random(int, System.Random)

Parameters Document each of the parameters here, with their name and description - i.e. this would be equivalent to the entry in the XMLDoc. Use a table layout like in the following example:

Parameter Type Description
length int The length of the string to generate.
random System.Random The instance of System.Random to use for the operation

Description Briefly but concisely document the method's purpose here. i.e. This would be the <summary> entry in the XMLDoc.

Benefits Give a reason as to why this method should be added. Does it add a need not satisified by any other X10D method? Does .NET not offer similar operations? Why should this method exist?

Drawbacks Give a reason as to why this method should not be added. Is it an expensive operation? Does it defy .NET guidelines? If you cannot think of any, leave this blank.

(Optional) Implementation example If you prefer, you can give an example of how this method might be implemented using a C# codeblock. Do not include the method signature here - just the body.

{
    // code
}