[DOCS] Edit recent updates for clarity and Elastic style #3194
+22
−20
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
🔍 Preview links for changed docs |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation for clarity and consistency with Elastic style guidelines. The changes focus on editorial refinements to the reference documentation, including correcting parameter types and improving language precision.
Key changes:
- Changed
from_andsizeparameters from string to integer values in code examples - Improved documentation language for clarity and consistency with Elastic style
- Standardized terminology (e.g., "ES|QL Query Builder" → "ES|QL query builder")
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/reference/index.md | Updated example code to use integer values for pagination parameters; improved documentation descriptions for clarity and style consistency |
| docs/reference/esql-query-builder.md | Standardized title capitalization from "ES|QL Query Builder" to "ES|QL query builder" |
| docs/reference/dsl_tutorials.md | Updated internal reference to match new standardized terminology |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pquentin
approved these changes
Nov 21, 2025
Member
pquentin
left a comment
pquentin
left a comment
There was a problem hiding this comment.
Thanks! LGTM.
TIL about [](foo.md).
miguelgrinberg
approved these changes
Nov 21, 2025
github-actions bot
pushed a commit
that referenced
this pull request
Nov 21, 2025
* [int]s not strings * Various cleanup (cherry picked from commit 1a0dae5)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
I was on PTO when #3158 flew by, so offering some suggestions in this PR.
Preview
docs/reference/index.md
Summary of changes
from_andsizeto integers rather than strings(Does not include any changes to the Compatibility section because I have an in-progress PR for that section)