Skip to content

Commit 38a86c6

Browse files
committed
Add a notice that dimension label APIs are experimental.
1 parent 16fc2e3 commit 38a86c6

File tree

4 files changed

+9
-0
lines changed

4 files changed

+9
-0
lines changed

sources/TileDB.CSharp/ArraySchema.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ public void AddAttributes(params Attribute[] attrs)
7777
/// <param name="name">The dimension label's name.</param>
7878
/// <param name="labelOrder">The data order of the dimension label.</param>
7979
/// <param name="labelType">The dimension lable's data type.</param>
80+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
8081
public void AddDimensionLabel(uint dimensionIndex, string name, DataOrder labelOrder, DataType labelType)
8182
{
8283
using var ctxHandle = _ctx.Handle.Acquire();
@@ -94,6 +95,7 @@ public void AddDimensionLabel(uint dimensionIndex, string name, DataOrder labelO
9495
/// <param name="labelType">The dimension lable's data type.</param>
9596
/// <param name="extent">The dimension label's tile extent.</param>
9697
/// <exception cref="InvalidOperationException"><typeparamref name="T"/> and <paramref name="labelType"/> do not match.</exception>
98+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
9799
public void AddDimensionLabel<T>(uint dimensionIndex, string name, DataOrder labelOrder, DataType labelType, T extent) where T : struct
98100
{
99101
if (RuntimeHelpers.IsReferenceOrContainsReferences<T>() || typeof(T) != EnumUtil.DataTypeToType(labelType))
@@ -177,6 +179,7 @@ public void SetCellOrder(LayoutType layoutType)
177179
/// </summary>
178180
/// <param name="name">The dimension label's name.</param>
179181
/// <param name="filterList">The dimension label's filter list.</param>
182+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
180183
public void SetDimensionLabelFilterList(string name, FilterList filterList)
181184
{
182185
using var ctxHandle = _ctx.Handle.Acquire();
@@ -536,6 +539,7 @@ public bool HasAttribute(string name)
536539
/// Gets a <see cref="CSharp.DimensionLabel"/> from the <see cref="ArraySchema"/> by name.
537540
/// </summary>
538541
/// <param name="name">The dimension label's name.</param>
542+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
539543
public DimensionLabel DimensionLabel(string name)
540544
{
541545
var handle = new DimensionLabelHandle();
@@ -570,6 +574,7 @@ public DimensionLabel DimensionLabel(string name)
570574
/// Checks if a dimension label with the given name exists in the <see cref="ArraySchema"/> or not.
571575
/// </summary>
572576
/// <param name="name">The name to check.</param>
577+
/// <remarks>This API is experimental and subject to breaking changes without advance notice.</remarks>
573578
public bool HasDimensionLabel(string name)
574579
{
575580
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)