Skip to content

Fix TableOperations.onDemand() javadoc #3268

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 3, 2023
Merged

Fix TableOperations.onDemand() javadoc #3268

merged 3 commits into from
Apr 3, 2023

Conversation

DomGarguilo
Copy link
Member

Fixes typos

@DomGarguilo DomGarguilo requested a review from dlmarion March 30, 2023 16:47
@ctubbsii
Copy link
Member

I think "on-demand" should be stylized with a hyphen when used as an adjective in prose/documentation. Variables/constants can be ON_DEMAND, or ONDEMAND, or onDemand, as needed, but when writing in English and not referring to the specific variable, the hyphenated form is more grammatically correct.

For what it's worth, https://en.wikipedia.org/wiki/On-demand uses the hyphenated form as its disambiguation page for the term. As an adjective, "on-demand" seems correct. However, as a prepositional phrase, "on demand" seems correct. So, an "on-demand table" is a "table [made available] on demand".

@DomGarguilo DomGarguilo requested a review from ctubbsii March 31, 2023 20:39
@DomGarguilo
Copy link
Member Author

The original intent of this PR was to fix the typos in TableOperations from "online" to "on-demand".

In the latest commit I took a quick look through the comments to see where I could apply the suggestions made by @ctubbsii.

Manno15
Manno15 approved these changes Apr 1, 2023
View reviewed changes
Copy link
Contributor

@Manno15 Manno15 left a comment

Choose a reason for hiding this comment

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

The changes look good. Just very small grammar things that could be improved.

@DomGarguilo DomGarguilo merged commit 7a54f64 into apache:elasticity Apr 3, 2023
@DomGarguilo DomGarguilo deleted the fixJavadoc branch April 3, 2023 15:17
@ctubbsii ctubbsii added this to the 4.0.0 milestone Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Manno15 Manno15 Manno15 approved these changes

@dlmarion dlmarion Awaiting requested review from dlmarion

@ctubbsii ctubbsii Awaiting requested review from ctubbsii

Assignees

@DomGarguilo DomGarguilo

Labels

None yet

Projects

Accumulo: Elasticity
Status: ✅ Done

Milestone

4.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@DomGarguilo @ctubbsii @Manno15