Skip to content

Commit 524b4c1

Browse files
authored
Spelling and documentation updates (#3)
1 parent 411f31e commit 524b4c1

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

OpenEphys.ProbeInterface/OpenEphys.ProbeInterface.csproj

+3-4
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,10 @@
99
<PackageTags>Bonsai Rx Open Ephys Onix</PackageTags>
1010
<VersionPrefix>0.1.0</VersionPrefix>
1111
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
12-
<GenerateDocumentationFile>true</GenerateDocumentationFile>
13-
<PackageOutputPath>..\bin\$(Configuration)</PackageOutputPath>
12+
<UseArtifactsOutput>true</UseArtifactsOutput>
13+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
1414
<PackageProjectUrl></PackageProjectUrl>
15-
<IncludeSymbols Condition="'$(Configuration)'=='Release'">true</IncludeSymbols>
16-
<GeneratePackageOnBuild Condition="'$(Configuration)'=='Release'">true</GeneratePackageOnBuild>
15+
<IncludeSymbols>true</IncludeSymbols>
1716
<RepositoryUrl>https://github.com/open-ephys/OpenEphys.ProbeInterface</RepositoryUrl>
1817
<RepositoryType>git</RepositoryType>
1918
<PackageLicenseFile>LICENSE</PackageLicenseFile>

OpenEphys.ProbeInterface/ProbeInterface.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public IEnumerable<Probe> Probes
5656
}
5757

5858
/// <summary>
59-
/// <see cref="ProbeGroup"/> constructor.
59+
/// Initializes a new instance of the <see cref="ProbeGroup"/> class.
6060
/// </summary>
6161
/// <param name="specification">Defines the <see cref="Specification"/> parameter</param>
6262
/// <param name="version">Defines the <see cref="Version"/> parameter</param>
@@ -71,7 +71,7 @@ public ProbeGroup(string specification, string version, IEnumerable<Probe> probe
7171
}
7272

7373
/// <summary>
74-
/// Copy constructor that takes in an existing <see cref="ProbeGroup"/> object and copies the individal fields.
74+
/// Copy constructor that takes in an existing <see cref="ProbeGroup"/> object and copies the individual fields.
7575
/// </summary>
7676
/// <param name="probeGroup"></param>
7777
protected ProbeGroup(ProbeGroup probeGroup)
@@ -376,7 +376,7 @@ public ProbeNdim NumDimensions
376376
}
377377

378378
/// <summary>
379-
/// Units to use while plottin the probe and all contacts. Options are
379+
/// Units to use while plotting the probe and all contacts. Options are
380380
/// <see cref="ProbeSiUnits.um"/> and <see cref="ProbeSiUnits.mm"/>.
381381
/// </summary>
382382
[XmlIgnore]
@@ -983,7 +983,7 @@ public string[] Annotations
983983
}
984984

985985
/// <summary>
986-
/// Constructor that initalizes the contact annotations class.
986+
/// Constructor that initializes the contact annotations class.
987987
/// </summary>
988988
/// <param name="contactAnnotations"></param>
989989
[JsonConstructor]

0 commit comments

Comments
 (0)