ESQL: Hide some "extras" from docs #124763
Conversation
Hides some of the "extra" lines from ESQL's documentation. These lines are required to make the documentation into nice tests which is important to make sure the docs don't get out of date. But readers don't need to see them.
nik9000
added
>docs
|
This is blocked on the ongoing docs rework. |
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-analytical-engine (Team:Analytics) |
There was a problem hiding this comment.
Looks good, but I have two concerns:
- Is it really necessary. I took a look at the rendered docs, and the extra SORT/LIMIT made the queries look a little more real-world without looking cluttered. Having said that I'm leaning towards doing it your way because these are reference docs and focus on the function at hand seems rational. But I wanted to just double-check this point.
- This PR does not include any of the generate docs. This has the advantage of being back-portable to 8.x, but the disadvantage of needing an immediate followup PR for both main and 8.x with these rendered docs, otherwise we will see what happened a couple of months ago with a PR unrelated to docs happening to include a bunch of docs stuff just because the developer ran some (or all) unit tests.
My vote is we rebase/squash these commits into one commit, cherry pick that to 8.x, and the make two PRs, one on main (this one) and one on 8.x (new PR) each with all necessary generated files. This PR can then auto-backport to 9.0, and the 8.x version can auto-backport to the versions we care about there.
Makes sense to me. I'll squash this one, then regenerate the docs. Then force push. Then make another PR against 8.x. |
nik9000
added
auto-merge-without-approval
Hides some of the "extra" lines from ESQL's documentation. These lines are required to make the documentation into nice tests which is important to make sure the docs don't get out of date. But readers don't need to see them.
Hides some of the "extra" lines from ESQL's documentation. These lines are required to make the documentation into nice tests which is important to make sure the docs don't get out of date. But readers don't need to see them.
3 participants
Hides some of the "extra" lines from ESQL's documentation. These lines are required to make the documentation into nice tests which is important to make sure the docs don't get out of date. But readers don't need to see them.