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.

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

fix an offense against the style guide. #13835

Merged
merged 2 commits into from
Apr 16, 2019
Merged

fix an offense against the style guide. #13835

merged 2 commits into from
Apr 16, 2019

Conversation

ptux
Copy link
Contributor

@ptux ptux commented Apr 16, 2019

Refer to API objects without saying “object,” unless omitting “object” leads to an awkward construction.

@ptux
fix an offense against the style guide.
ae4999f 
> Refer to API objects without saying “object,” unless omitting “object” leads to an awkward construction.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Apr 16, 2019
@ptux
Copy link
Contributor Author

ptux commented Apr 16, 2019

/assign @bradtopol

@netlify
Copy link

netlify bot commented Apr 16, 2019 •
edited
Loading

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 8dc42b9

https://deploy-preview-13835--kubernetes-io-master-staging.netlify.com

bradtopol
bradtopol reviewed Apr 16, 2019
View reviewed changes
content/en/docs/concepts/overview/working-with-objects/kubernetes-objects.md Outdated
@@ -66,7 +66,7 @@ In the `.yaml` file for the Kubernetes object you want to create, you'll need to
You'll also need to provide the object `spec` field. The precise format of the object `spec` is different for every Kubernetes object, and contains nested fields specific to that object. The [Kubernetes API Reference](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/) can help you find the spec format for all of the objects you can create using Kubernetes.
For example, the `spec` format for a `Pod` object can be found
Copy link
Contributor

Choose a reason for hiding this comment

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

For consistency can you fix the Pod object as well?

@bradtopol
Copy link
Contributor

Hi @ptux thank you for your contribution. Can you fix the Pod object as well that is right above for consistency? See my inline comment. Thanks

@bradtopol
Copy link
Contributor

Actually, @ptux looking at the context I believe leaving in object helps to clarify the association between Pod and Deployment being object types. So I am inclined to leave in object as it provides clarity.

@ptux
Copy link
Contributor Author

ptux commented Apr 16, 2019

In that kind of meaning, we should change the style guide.

@bradtopol
Copy link
Contributor

It's a borderline case but it reads ok with with object removed. So let's go with the style guide. I'll merge it. Great job!
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 16, 2019
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bradtopol

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 16, 2019
@k8s-ci-robot k8s-ci-robot merged commit 49b40db into kubernetes:master Apr 16, 2019
@ptux
Copy link
Contributor Author

ptux commented Apr 16, 2019

@bradtopol

Thank you.

In my opinion, in the Kubernetes world, user should understand Pod without object.

@bradtopol
Copy link
Contributor

Agreed!

@ptux ptux deleted the patch-3 branch April 16, 2019 03:15
McCoyAle pushed a commit to McCoyAle/website that referenced this pull request Apr 16, 2019
@ptux @McCoyAle
fix an offense against the style guide. (kubernetes#13835)
eca1661 
* fix an offense against the style guide.

> Refer to API objects without saying “object,” unless omitting “object” leads to an awkward construction.

* fix another one.
nowjean pushed a commit to nowjean/website that referenced this pull request Jun 13, 2019
@ptux @nowjean
fix an offense against the style guide. (kubernetes#13835)
8652f4d 
* fix an offense against the style guide.

> Refer to API objects without saying “object,” unless omitting “object” leads to an awkward construction.

* fix another one.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradtopol bradtopol bradtopol left review comments

@Rajakavitha1 Rajakavitha1 Awaiting requested review from Rajakavitha1

@xiangpengzhao xiangpengzhao Awaiting requested review from xiangpengzhao

Assignees

@bradtopol bradtopol

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ptux @bradtopol @k8s-ci-robot