Add CHANGELOG.md #126
Draft
Add CHANGELOG.md #126
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lornazh
reviewed
Sep 20, 2024
| - New Bitwise Math Operations Added `PinSiteData<T>` | ||
| - `ShiftLeft(int count)` | ||
| - Return Type: `PinSiteData<T>` | ||
| - Description: Shifts the value to the left by the specified bit count, for each element, per site. The count must be positive. This method is supported only when the underlying data type of the `PinSiteData<T>` object, `T`, is an integer type. |
There was a problem hiding this comment.
Want to mention the operator like you do for bitwise AND (&)?
"Shifts the value to the left (<<) by the specified bit count"
Same comment to ShiftRight and to SiteData shift methods.
lornazh
reviewed
Sep 20, 2024
| - Description: Calculates the mean value across sites. | ||
| - New constructors added to `PinSiteData<T>` and `SiteData<T>` | ||
| - `PinSiteData<T>` | ||
| - `PinSiteData(Dictionary<string, T> pinData, int[] siteNumbers)`: Initializes a PinSiteData object with pin unique data. Where the specified pin unique data value will be repeated across all sites. |
There was a problem hiding this comment.
The order of the two parameters are inverted.
lornazh
reviewed
Sep 20, 2024
| - `SiteData<T>` | ||
| - `SiteData(int[] siteNumbers, T[] perSiteData)`: Initializes a SiteData object with site unique data. | ||
| - New `Select` Method added to support advanced element-by-element data transformations (such as changing type) and complex math operations. | ||
| - `SiteData<T>.Select<TResult>(Func<T, TResult> operation)` |
There was a problem hiding this comment.
Should be "SiteData<TResult>.Select(Func<T, TResult> operation)"
lornazh
reviewed
Sep 20, 2024
| - Description: Selects each element, of type `T` within the `SiteData<T>` object to perform an operation on that element and return a new `SiteData` object containing the result of that operation, `TResult`. | ||
| - Return Type: `SiteData<TResult>` | ||
| - Example: `SiteData<double> MySiteDataAsDoubleObj = MySiteDataAsIntObj.Select(x => (double)x);` | ||
| - `PinSiteData<T>.Select<TResult>(Func<T, TResult> operation)` |
There was a problem hiding this comment.
Should be "PinSiteData<TResult>.Select(Func<T, TResult> operation)"
lornazh
reviewed
Sep 20, 2024
| - Example: `SiteData<double> MySiteDataAsDoubleObj = MySiteDataAsIntObj.Select(x => (double)x);` | ||
| - `PinSiteData<T>.Select<TResult>(Func<T, TResult> operation)` | ||
| - Description: Selects each element, of type `T` within the `PinSiteData<T>` object to perform an operation on that element and return a new `PinSiteData` object containing the result of that operation, `TResult`. | ||
| - Return Type: `SiteData<TResult>` |
lornazh
reviewed
Sep 20, 2024
| - For `SiteData<T>` objects, the scalar value will be applied to all elements in the array, across each site. | ||
| - `Utilities.TryDeterminePowerLineFrequency` updated to now support OfflineMode. | ||
| - `TestStandSteps.ContinuityTest` modified to correctly accept negative current level values. | ||
| - CSProject files for TestStandSteps and Extensions now exclude net48 path from being included as a folder within the project, which was could cause build issues for contributors in certain situations. |
There was a problem hiding this comment.
"..., which was causing..." or "..., which could cause..."?
lornazh
approved these changes
Sep 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this Pull Request accomplish?
Adds a CHANGELOG.md file to track changes from release to release.
Why should this Pull Request be merged?
The project needs a means of keeping track changes from release to release.
What testing has been done?
This is just a text file being added, no testing done or required.