Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-2449-Header PROFILE added #753

Open
wants to merge 4 commits into
base: 4.2.0-dev
Choose a base branch
from

Conversation

Tushar-TG-14
Copy link
Collaborator

No description provided.

Comment on lines 2749 to 2751
|This header is used for query profiling. Currently, it supports only the value `BASIC`.
When activated, query profiling allows users to view and analyze detailed information about query execution.
By default, the value is empty, and profiling is not activated.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|This header is used for query profiling. Currently, it supports only the value `BASIC`.
When activated, query profiling allows users to view and analyze detailed information about query execution.
By default, the value is empty, and profiling is not activated.
|Specifies the type of query profiling. Currently, only `BASIC` is supported.
Query profiling profiles detailed information about query execution for users to view and analyze.
Default: empty (no profiling).

You do not need or want a complete sentence at the beginning of a Description in a table like this. The table structure already implies: "This is ." See the existing rows in the table.

Headers are a standard concept for REST APIs, so you don't need any example here. Notice that none of the other rows have an example.

BUT, we need to tell users where to look to see the query profile output. I think the engineer posted an example, but I haven't looked at it yet. I assume you are adding a section somewhere else to describe the query profiling feature. After you do that, add an xref here to link to that section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@victorleeTG Noted.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants