Skip to content

[Feedback]: Search preference documentation is malformed #1311

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

Closed
aarongray-st opened this issue Apr 29, 2025 · 1 comment · Fixed by elastic/elasticsearch-specification#4336
Assignees
Labels
Team:Platform Issues owned by the Platform Docs Team

Comments

@aarongray-st
Copy link

Was the documentation helpful?

Yes

What documentation page is affected

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-search#operation-search-preference

Description

It looks like the bulleted list formatting is broken. From context, it appears that the "shards" and "custom string" options should be their own bullet points, but they are combined with "_prefer_nodes," making it difficult to read.

@github-actions github-actions bot added the needs-team Issues pending triage by the Docs Team label Apr 29, 2025
@lcawl lcawl self-assigned this Apr 30, 2025
@lcawl lcawl added Team:Platform Issues owned by the Platform Docs Team and removed needs-team Issues pending triage by the Docs Team labels Apr 30, 2025
@lcawl
Copy link
Contributor

lcawl commented Apr 30, 2025

Thanks for reporting this issue! I created elastic/elasticsearch-specification#4336 to add the missing bullets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Platform Issues owned by the Platform Docs Team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants