📝 Add docstrings to rd_decimal
#53
Merged
Conversation
This file contains hidden or 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
Docstrings generation was requested by @RaphDal. * #52 (comment) The following files were modified: * `src/dummy-http-server/DummyHttpServer.cs` * `src/net-questdb-client-tests/DecimalTestHelpers.cs` * `src/net-questdb-client-tests/DummyIlpServer.cs` * `src/net-questdb-client-tests/JsonSpecTestRunner.cs` * `src/net-questdb-client/Buffers/Buffer.cs` * `src/net-questdb-client/Buffers/BufferV1.cs` * `src/net-questdb-client/Buffers/BufferV2.cs` * `src/net-questdb-client/Buffers/BufferV3.cs` * `src/net-questdb-client/Buffers/IBuffer.cs` * `src/net-questdb-client/Senders/AbstractSender.cs` * `src/net-questdb-client/Senders/HttpSender.cs` * `src/net-questdb-client/Senders/ISender.cs`
|
|
Author
|
Important Review skippedCodeRabbit bot authored PR detected. To trigger a single review, invoke the You can disable this status message by setting the Comment |
RaphDal
reviewed
Oct 17, 2025
Comment on lines
+34
to
+50
| /// <summary> | ||
| /// Creates an IBuffer instance, based on the provided protocol version. | ||
| /// </summary> | ||
| /// <param name="bufferSize"></param> | ||
| /// <param name="maxNameLen"></param> | ||
| /// <param name="maxBufSize"></param> | ||
| /// <param name="version"></param> | ||
| /// <returns></returns> | ||
| /// <exception cref="NotImplementedException"></exception> | ||
| /// <summary> | ||
| /// Creates a concrete IBuffer implementation configured for the specified protocol version. | ||
| /// </summary> | ||
| /// <param name="bufferSize">Size in bytes of each buffer segment.</param> | ||
| /// <param name="maxNameLen">Maximum allowed length for names stored in the buffer.</param> | ||
| /// <param name="maxBufSize">Maximum total buffer capacity.</param> | ||
| /// <param name="version">Protocol version that determines which concrete buffer implementation to create.</param> | ||
| /// <returns>An <see cref="IBuffer"/> instance corresponding to the specified protocol version.</returns> | ||
| /// <exception cref="NotImplementedException">Thrown when an unsupported protocol version is provided.</exception> |
There was a problem hiding this comment.
This method is already commented. Replace the previous comment with your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
248
to
255
| /// <summary> | ||
| /// Records a DECIMAL column value using the ILP binary decimal layout. | ||
| /// </summary> | ||
| /// <summary> | ||
| /// Writes a DECIMAL column with the specified name using the ILP binary decimal layout. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">The decimal value to write, or `null` to write a NULL column.</param> | ||
| /// <returns>The buffer instance for method chaining.</returns> |
There was a problem hiding this comment.
Replace the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
226
to
232
| /// <summary> | ||
| /// Creates a new HTTP request with appropriate encoding. | ||
| /// </summary> | ||
| /// <returns></returns> | ||
| /// <summary> | ||
| /// Create an HTTP POST request targeting "/write" with the sender's buffer as the request body. | ||
| /// </summary> | ||
| /// <returns>An <see cref="HttpRequestMessage"/> configured with the buffer as the request body, Content-Type set to "text/plain" with charset "utf-8", and Content-Length set to the buffer length.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
124
to
132
| /// </summary> | ||
| /// <param name="name">The name of the column</param> | ||
| /// <param name="value">The value for the column</param> | ||
| /// <returns>Itself</returns> | ||
| /// <summary> | ||
| /// Adds a column (field) with the specified string value to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">The column value as a character span.</param> | ||
| /// <returns>The sender instance for fluent chaining.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
135
to
140
| /// <summary> | ||
| /// Adds a column with the specified name and 64-bit integer value to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column (field) name.</param> | ||
| /// <param name="value">The 64-bit integer value for the column.</param> | ||
| /// <returns>The current sender instance for method chaining.</returns> |
There was a problem hiding this comment.
There is a problem with your indentation there.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
146
to
176
| /// <summary> | ||
| /// Adds a boolean field column with the specified name and value to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column (field) name.</param> | ||
| /// <param name="value">The boolean value to store in the column.</param> | ||
| /// <returns>The same <see cref="ISender"/> instance to allow fluent chaining.</returns> | ||
| public ISender Column(ReadOnlySpan<char> name, bool value); | ||
|
|
||
| /// <inheritdoc cref="Column(ReadOnlySpan{char},ReadOnlySpan{char})" /> | ||
| /// <summary> | ||
| /// Adds a double-precision field column to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column (field) name.</param> | ||
| /// <param name="value">The column's double-precision value.</param> | ||
| /// <returns>The same <see cref="ISender"/> instance for fluent chaining.</returns> | ||
| public ISender Column(ReadOnlySpan<char> name, double value); | ||
|
|
||
| /// <inheritdoc cref="Column(ReadOnlySpan{char},ReadOnlySpan{char})" /> | ||
| /// <summary> | ||
| /// Adds a column (field) with the specified DateTime value to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">The DateTime value to add.</param> | ||
| /// <returns>The same <see cref="ISender"/> instance for fluent chaining.</returns> | ||
| public ISender Column(ReadOnlySpan<char> name, DateTime value); | ||
|
|
||
| /// <inheritdoc cref="Column(ReadOnlySpan{char},ReadOnlySpan{char})" /> | ||
| /// <summary> | ||
| /// Adds a column with the specified name and DateTimeOffset value to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">The DateTimeOffset value to store for the column (used as a timestamp value).</param> | ||
| /// <returns>The sender instance for fluent chaining.</returns> | ||
| public ISender Column(ReadOnlySpan<char> name, DateTimeOffset value); |
RaphDal
reviewed
Oct 17, 2025
Comment on lines
242
to
246
| /// <summary> | ||
| /// Clears the sender's buffer. | ||
| /// </summary> | ||
| /// <summary> | ||
| /// Clears the sender's internal buffer and resets buffer-related state, removing all pending rows. | ||
| /// </summary> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
249
to
257
| /// <inheritdoc | ||
| /// cref="Column{T}(ReadOnlySpan{char},IEnumerable{T},IEnumerable{int})" /> | ||
| /// <summary> | ||
| /// Adds a column to the current row using a sequence of value-type elements and an explicit multidimensional shape. | ||
| /// </summary> | ||
| /// <typeparam name="T">The element value type stored in the column.</typeparam> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">A sequence of elements that form the column's data.</param> | ||
| /// <param name="shape">A sequence of integers describing the dimensions of the array representation; dimension lengths must match the number of elements in <paramref name="value"/> when multiplied together.</param> | ||
| /// <returns>The same <see cref="ISender"/> instance for fluent chaining.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
260
to
271
| /// <summary> | ||
| /// Adds an ARRAY to the current row. | ||
| /// Arrays are n-dimensional non-jagged arrays. | ||
| /// </summary> | ||
| /// <param name="name"></param> | ||
| /// <param name="value"></param> | ||
| /// <returns></returns> | ||
| /// <summary> | ||
| /// Adds a column whose value is provided as a native array; multidimensional (non-jagged) arrays are supported. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">A native array containing the column data. Multidimensional arrays are treated as shaped data (do not pass jagged arrays).</param> | ||
| /// <returns>The sender instance for fluent chaining.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
274
to
280
| /// <inheritdoc | ||
| /// cref="Column{T}(ReadOnlySpan{char},IEnumerable{T},IEnumerable{int})" /> | ||
| /// <summary> | ||
| /// Adds a column with the specified name and a sequence of value-type elements from a span to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column (field) name.</param> | ||
| /// <param name="value">A contiguous sequence of value-type elements representing the column data.</param> | ||
| /// <returns>The same <see cref="ISender"/> instance to allow fluent chaining.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
283
to
293
| /// <summary> | ||
| /// Adds a column (field) to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The name of the column</param> | ||
| /// <param name="value">The value for the column</param> | ||
| /// <returns>Itself</returns> | ||
| /// <summary> | ||
| /// Adds a column with the specified string value to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">The column's string value; may be null.</param> | ||
| /// <returns>The same sender instance for fluent chaining.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
RaphDal
reviewed
Oct 17, 2025
Comment on lines
429
to
436
| /// <summary> | ||
| /// Adds a DECIMAL column in the binary format. | ||
| /// </summary> | ||
| /// <summary> | ||
| /// Adds a decimal column in binary format to the current row. | ||
| /// </summary> | ||
| /// <param name="name">The column name.</param> | ||
| /// <param name="value">The decimal value to add; may be null to represent a NULL field.</param> | ||
| /// <returns>The sender instance for fluent call chaining.</returns> |
There was a problem hiding this comment.
Remove the previous comment by your own.
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.
Docstrings generation was requested by @RaphDal.
The following files were modified:
src/dummy-http-server/DummyHttpServer.cssrc/net-questdb-client-tests/DecimalTestHelpers.cssrc/net-questdb-client-tests/DummyIlpServer.cssrc/net-questdb-client-tests/JsonSpecTestRunner.cssrc/net-questdb-client/Buffers/Buffer.cssrc/net-questdb-client/Buffers/BufferV1.cssrc/net-questdb-client/Buffers/BufferV2.cssrc/net-questdb-client/Buffers/BufferV3.cssrc/net-questdb-client/Buffers/IBuffer.cssrc/net-questdb-client/Senders/AbstractSender.cssrc/net-questdb-client/Senders/HttpSender.cssrc/net-questdb-client/Senders/ISender.csThese files were ignored
src/net-questdb-client-tests/HttpTests.cssrc/net-questdb-client-tests/LineTcpSenderTests.cssrc/net-questdb-client-tests/TcpTests.csThese file types are not supported
README.mdnet-questdb-client.slnsrc/example-aot/example-aot.csprojsrc/net-questdb-client-benchmarks/net-questdb-client-benchmarks.csprojℹ️ Note