Skip to content

feat: implement constructor for BridgeApi with key and name parameters #1395

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.

Sign up for GitHub

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

Merged
ediablo80 merged 1 commit into from
Mar 12, 2026
+12 −1
Merged

feat: implement constructor for BridgeApi with key and name parameters #1395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion src/PepperDash.Essentials.Core/Bridges/BridgeBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ protected BridgeApi(string key) :
{

}

/// <summary>
/// Constructor
/// </summary>
/// <param name="key"></param>
/// <param name="name"></param>
Comment on lines +37 to +38
Copy link

Copilot AI Mar 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The XML doc comments for this new constructor have empty <param> descriptions. Please document what key and name represent (similar to the existing single-parameter constructor) so generated docs/intellisense are useful.

Suggested change
/// <param name="key"></param>
/// <param name="name"></param>
/// <param name="key">Device key</param>
/// <param name="name">Device name</param>

Copilot uses AI. Check for mistakes.
protected BridgeApi(string key, string name) :
base(key, name)
{

}
}

/// <summary>
Expand Down Expand Up @@ -58,7 +69,7 @@ public class EiscApiAdvanced : BridgeApi, ICommunicationMonitor
/// <param name="dc">Device configuration</param>
/// <param name="eisc">EISC instance</param>
public EiscApiAdvanced(DeviceConfig dc, BasicTriList eisc) :
base(dc.Key)
base(dc.Key, dc.Name)
{
JoinMaps = new Dictionary<string, JoinMapBaseAdvanced>();

Expand Down
Loading