Skip to content
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

Brief document blurb about RestClient #107863

Merged
merged 1 commit into from
May 8, 2024

Conversation

DiannaHohensee
Copy link
Contributor

No description provided.

@DiannaHohensee DiannaHohensee added >non-issue :Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. Team:Distributed Meta label for distributed team labels Apr 24, 2024
@DiannaHohensee DiannaHohensee self-assigned this Apr 24, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

LGTM, although I feel this'd be more discoverable in the javadocs for RestClient instead of tucked away here.

@DiannaHohensee
Copy link
Contributor Author

this'd be more discoverable in the javadocs for RestClient instead of tucked away here.

I typically view documentation on a particular class as restricted to describing what a class does and how it should be best / safely used. Explaining where and why the class is used by callers would be a layer violation -- the class is just supposed to know about itself. A new package-info.java file in org.elasticsearch.client also seems like the same sort of deal, at the package level: describe what the code does and how to use the code, not who uses the code outside the package.

Were you thinking of somewhere else than class level documentation, or do you think about documentation differently?

@DiannaHohensee DiannaHohensee merged commit 87df295 into elastic:main May 8, 2024
5 checks passed
markjhoy pushed a commit to markjhoy/elasticsearch that referenced this pull request May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. >non-issue Team:Distributed Meta label for distributed team v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants