fix description of from and size example #28320
Conversation
`from` means where to start and `size` means how many results so the response cannot be elements from 11 to 20, the response is elements from 10 to 19.
|
Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually? |
1 similar comment
|
Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually? |
There was a problem hiding this comment.
@alexmorosmarco I agree, as a developer I find your change to the docs more natural, even though if you don't assume 0-based counting for the search results if might make more sense to start with 11 here? I agree with your argument though and will merge this change if noboby else objects in a short period of time. Could you sign the CLA in the meantime?
|
Hi, thanks to answer so quick Same wrong conclussion is in the Elastic last documentation, I guess you can check all the versions and fix it everywhere. Please, can you tell me where to sign the CLA? |
I agree with your point of view, I was just pointing out that for some people that are not used to 0-based counting those would be documents 1-10. But since
We usually merge smaller documentation changes like this with past versions, but probably not to all of them. Usually down to the last release of the last mayor version (that would be the 5.6 branch in this case)
You can follow the steps at https://www.elastic.co/contributor-agreement |
|
Hi, about your 1st point I understand. But this is a technical documentation so we cannot explain something incoherent or we cannot explain "the numbers" in a non technical (non 0-based) way. Otherwise it is confusing. About merging this in other versions, I think it is wrong explanation that should be fixed in all the versions. I detected it in 2.4 but of course it is present in 6.1. Please could you apply it in all of them? I have signed the CLA. Thanks! |
|
I take the opportunity to ask you something. Do you know if someone will be assigned or how it works? |
|
To answer the last question first: opening an issue if you think some parts of the docs are misleading or not easy to understand is exactly the right thing to do, thanks for doing that. These issues usually get labeled and then taken of the stack whenever somebody (including members from the community jumping in) feels like they can contribute something, but there is no definite commitment in terms of timing for these things. As you can see there are quiet a lot of open issues, but docs are usually picked up faster than other things. Hope this helps. |
We usually merge changes like this to all branches in the current major version and the last on the previous minors that are still supported. So in this case this can go to 2.4, 5.6 and all 6.x branches. |
There was a problem hiding this comment.
LGTM since there is no a argument against this channge, but several in favour. Going to merge this, thanks @alexmorosmarco
* es/master: [Docs] Fix explanation for `from` and `size` example (#28320) Adapt bwc version after backport #28358 Always return the after_key in composite aggregation response (#28358) Adds test name to MockPageCacheRecycler exception (#28359) Adds a note in the `terms` aggregation docs regarding pagination (#28360) [Test] Fix DiscoveryNodesTests.testDeltas() (#28361) Update packaging tests to work with meta plugins (#28336) Remove Painless Type from MethodWriter in favor of Java Class. (#28346) [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (#28348) Reindex: Shore up rethrottle test Only assert single commit iff index created on 6.2 isHeldByCurrentThread should return primitive bool [Docs] Clarify `html` encoder in highlighting.asciidoc (#27766) Fix GeoDistance query example (#28355) Settings: Introduce settings updater for a list of settings (#28338) Adapt bwc version after backport #28310
* es/6.x: [Docs] Fix explanation for `from` and `size` example (#28320) Adapt bwc version after backport #28358 Always return the after_key in composite aggregation response (#28358) Adds a note in the `terms` aggregation docs regarding pagination (#28360) Update packaging tests to work with meta plugins (#28336) Remove Painless Type from MethodWriter in favor of Java Class. (#28346) [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (#28348) [Docs] Fixed Indices information breaking changes (#27914) Reindex: Shore up rethrottle test isHeldByCurrentThread should return primitive bool [Docs] Clarify `html` encoder in highlighting.asciidoc (#27766) Only assert single commit iff index created on 6.2 Deprecate the `update_all_types` option. (#28284) Fix GeoDistance query example Settings: Introduce settings updater for a list of settings (#28338) [Docs] Fix asciidoc style in composite agg docs Adapt bwc version after backport #28310 Adds the ability to specify a format on composite date_histogram source (#28310)
* master: (23 commits) Update Netty to 4.1.16.Final (elastic#28345) Fix peer recovery flushing loop (elastic#28350) REST high-level client: add support for exists alias (elastic#28332) REST high-level client: move to POST when calling API to retrieve which support request body (elastic#28342) Add Indices Aliases API to the high level REST client (elastic#27876) Java Api clean up: remove deprecated `isShardsAcked` (elastic#28311) [Docs] Fix explanation for `from` and `size` example (elastic#28320) Adapt bwc version after backport elastic#28358 Always return the after_key in composite aggregation response (elastic#28358) Adds test name to MockPageCacheRecycler exception (elastic#28359) Adds a note in the `terms` aggregation docs regarding pagination (elastic#28360) [Test] Fix DiscoveryNodesTests.testDeltas() (elastic#28361) Update packaging tests to work with meta plugins (elastic#28336) Remove Painless Type from MethodWriter in favor of Java Class. (elastic#28346) [Doc] Fixs typo in reverse-nested-aggregation.asciidoc (elastic#28348) Reindex: Shore up rethrottle test Only assert single commit iff index created on 6.2 isHeldByCurrentThread should return primitive bool [Docs] Clarify `html` encoder in highlighting.asciidoc (elastic#27766) Fix GeoDistance query example (elastic#28355) ...
frommeans where to start andsizemeans how many results so the response cannot be elements from 11 to 20, the response is elements from 10 to 19.