Skip to content

Explain how to use sub clients in API docs #2798

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

Merged
merged 2 commits into from
Feb 14, 2025

Conversation

pquentin
Copy link
Member

I have not found a way to not display the name of the class. But I removed the parameters and added an explanation text.

Before

Screenshot 2025-02-14 at 18 17 23

After

Screenshot 2025-02-14 at 18 17 03

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

@miguelgrinberg miguelgrinberg left a comment

Choose a reason for hiding this comment

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

Big improvement.

@pquentin pquentin merged commit db22037 into elastic:main Feb 14, 2025
13 checks passed
github-actions bot pushed a commit that referenced this pull request Feb 14, 2025
github-actions bot pushed a commit that referenced this pull request Feb 14, 2025
github-actions bot pushed a commit that referenced this pull request Feb 14, 2025
pquentin added a commit that referenced this pull request Feb 18, 2025
(cherry picked from commit db22037)

Co-authored-by: Quentin Pradet <[email protected]>
pquentin added a commit that referenced this pull request Feb 18, 2025
(cherry picked from commit db22037)

Co-authored-by: Quentin Pradet <[email protected]>
pquentin added a commit that referenced this pull request Feb 21, 2025
(cherry picked from commit db22037)

Co-authored-by: Quentin Pradet <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants