Skip to content

Commit 6ed3afa

Browse files
committed
Add a notice that dimension label APIs are experimental.
1 parent 785ff7c commit 6ed3afa

4 files changed

Lines changed: 9 additions & 0 deletions

File tree

sources/TileDB.CSharp/ArraySchema.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ public void AddAttributes(params Attribute[] attrs)
7373
/// <param name="name">The dimension label's name.</param>
7474
/// <param name="labelOrder">The data order of the dimension label.</param>
7575
/// <param name="labelType">The dimension lable's data type.</param>
76+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
7677
public void AddDimensionLabel(uint dimensionIndex, string name, DataOrder labelOrder, DataType labelType)
7778
{
7879
using var ctxHandle = _ctx.Handle.Acquire();
@@ -90,6 +91,7 @@ public void AddDimensionLabel(uint dimensionIndex, string name, DataOrder labelO
9091
/// <param name="labelType">The dimension lable's data type.</param>
9192
/// <param name="extent">The dimension label's tile extent.</param>
9293
/// <exception cref="InvalidOperationException"><typeparamref name="T"/> and <paramref name="labelType"/> do not match.</exception>
94+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
9395
public void AddDimensionLabel<T>(uint dimensionIndex, string name, DataOrder labelOrder, DataType labelType, T extent) where T : struct
9496
{
9597
if (RuntimeHelpers.IsReferenceOrContainsReferences<T>() || typeof(T) != EnumUtil.DataTypeToType(labelType))
@@ -173,6 +175,7 @@ public void SetCellOrder(LayoutType layoutType)
173175
/// </summary>
174176
/// <param name="name">The dimension label's name.</param>
175177
/// <param name="filterList">The dimension label's filter list.</param>
178+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
176179
public void SetDimensionLabelFilterList(string name, FilterList filterList)
177180
{
178181
using var ctxHandle = _ctx.Handle.Acquire();
@@ -532,6 +535,7 @@ public bool HasAttribute(string name)
532535
/// Gets a <see cref="CSharp.DimensionLabel"/> from the <see cref="ArraySchema"/> by name.
533536
/// </summary>
534537
/// <param name="name">The dimension label's name.</param>
538+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
535539
public DimensionLabel DimensionLabel(string name)
536540
{
537541
var handle = new DimensionLabelHandle();
@@ -566,6 +570,7 @@ public DimensionLabel DimensionLabel(string name)
566570
/// Checks if a dimension label with the given name exists in the <see cref="ArraySchema"/> or not.
567571
/// </summary>
568572
/// <param name="name">The name to check.</param>
573+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
569574
public bool HasDimensionLabel(string name)
570575
{
571576
int has_attr;

sources/TileDB.CSharp/DataOrder.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ namespace TileDB.CSharp
55
/// <summary>
66
/// Specifies the order of data in dimension labels.
77
/// </summary>
8+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
89
public enum DataOrder
910
{
1011
/// <summary>

sources/TileDB.CSharp/DimensionLabel.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ namespace TileDB.CSharp
77
/// <summary>
88
/// Represents a TileDB dimension label object.
99
/// </summary>
10+
/// <remarks>This API is experimental and susceptible to breaking changes without advance notice.</remarks>
1011
/// <seealso cref="ArraySchema.DimensionLabel"/>
1112
public sealed unsafe class DimensionLabel : IDisposable
1213
{

sources/TileDB.CSharp/Subarray.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,7 @@ private void ValidateType<T>(uint index) where T : struct
184184
/// <param name="start">The start of the dimension's range.</param>
185185
/// <param name="end">The end of the dimension's range.</param>
186186
/// <exception cref="NotSupportedException"><typeparamref name="T"/> is not supported.</exception>
187+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
187188
public void AddLabelRange<T>(string labelName, T start, T end) where T : struct
188189
{
189190
ValidateLabelType<T>(labelName);
@@ -204,6 +205,7 @@ private void AddLabelRange(string labelName, void* start, void* end, void* strid
204205
/// <param name="labelName">The dimension label's name.</param>
205206
/// <param name="start">The start of the dimension label's range.</param>
206207
/// <param name="end">The end of the dimension label's range.</param>
208+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
207209
public void AddLabelRange(string labelName, string start, string end)
208210
{
209211
using var ctxHandle = _ctx.Handle.Acquire();

0 commit comments

Comments
 (0)