Change - Documentation Update #1380
Open
Conversation
This file contains 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
|
@nidhi752 Still there are some linter errors in your PR. kindly have a look at the workflow run : https://github.com/gofr-dev/gofr/actions/runs/12684562987?pr=1380 and resolve the linters |
ccoVeille
reviewed
Jan 9, 2025
| func New(config Config) *Client { | ||
| return &Client{config: config} | ||
| } | ||
|
|
||
| // UseLogger sets the logger for the Clickhouse client. | ||
| // The logger must implement the Logger interface. |
There was a problem hiding this comment.
You could use godoc link
Suggested change
| // The logger must implement the Logger interface. | |
| // The logger must implement the [Logger] interface. |
Also the must is a bit strong as you can pass something that doesn't, it would be ignored
| func (c *Client) UseLogger(logger interface{}) { | ||
| if l, ok := logger.(Logger); ok { | ||
| c.logger = l | ||
| } | ||
| } | ||
|
|
||
| // UseMetrics sets the metrics for the Clickhouse client. | ||
| // The metrics must implement the Metrics interface. |
There was a problem hiding this comment.
Suggested change
| // The metrics must implement the Metrics interface. | |
| // The metrics must implement the [Metrics] interface. |
And same remark about "must"
| ) | ||
|
|
||
|
|
||
| // Config defines the configuration needed to connect to a Clickhouse database. |
There was a problem hiding this comment.
Suggested change
| // Config defines the configuration needed to connect to a Clickhouse database. | |
| // Config defines the configuration needed to connect to a ClickHouse database. |
| } | ||
|
|
||
| // Client represents the Clickhouse client, encapsulating connection details, configuration, logging, metrics, and tracing. |
There was a problem hiding this comment.
Suggested change
| // Client represents the Clickhouse client, encapsulating connection details, configuration, logging, metrics, and tracing. | |
| // Client represents the ClickHouse client, encapsulating connection details, configuration, logging, metrics, and tracing. |
| // client.UseMetrics(Metrics()) | ||
| // | ||
| // client.Connect() | ||
| // New initializes a new Clickhouse client with the provided configuration. |
There was a problem hiding this comment.
Suggested change
| // New initializes a new Clickhouse client with the provided configuration. | |
| // New initializes a new ClickHouse client with the provided configuration. |
| func (c *Client) UseMetrics(metrics interface{}) { | ||
| if m, ok := metrics.(Metrics); ok { | ||
| c.metrics = m | ||
| } | ||
| } | ||
|
|
||
| // UseTracer sets the tracer for Clickhouse client. | ||
| // UseTracer sets the OpenTelemetry tracer for the Clickhouse client. |
There was a problem hiding this comment.
Suggested change
| // UseTracer sets the OpenTelemetry tracer for the Clickhouse client. | |
| // UseTracer sets the OpenTelemetry tracer for the ClickHouse client. |
| func (c *Client) UseTracer(tracer any) { | ||
| if t, ok := tracer.(trace.Tracer); ok { | ||
| c.tracer = t | ||
| } | ||
| } | ||
|
|
||
| // Connect establishes a connection to Clickhouse and registers metrics using the provided configuration when the client was Created. | ||
| // Connect establishes a connection to the Clickhouse database using the client's configuration. |
There was a problem hiding this comment.
Suggested change
| // Connect establishes a connection to the Clickhouse database using the client's configuration. | |
| // Connect establishes a connection to the ClickHouse database using the client's configuration. |
4 tasks
|
@nidhi752 Please address the review comments given in the PR. |
|
@Umang01-hash |
Yes @nidhi752 @ccoVeille has requested a few please check |
|
@nidhi752 Requesting you to please work on the review comments else we will need to close the PR due to inactivity. |
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.
Pull Request Template
Description:
Checklist:
goimportandgolangci-lint.Thank you for your contribution!