Skip to content

Commit

Permalink
[Docs] Document that we follow the Google editorial style (#36695)
Browse files Browse the repository at this point in the history
Our documentation style is inconsistent. This hurts readability and perceived quality.

---------

Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
  • Loading branch information
bveeramani authored Jun 22, 2023
1 parent 8e45d2d commit a23ef5f
Showing 1 changed file with 26 additions and 10 deletions.
36 changes: 26 additions & 10 deletions doc/source/ray-contribute/docs.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@
"\n",
"This document walks you through everything you need to do to get started.\n",
"\n",
"\n",
"## Editorial style\n",
"\n",
"We follow the [Google developer documentation style guide](https://developers.google.com/style).\n",
"Here are some highlights:\n",
"\n",
"* [Use present tense](https://developers.google.com/style/tense)\n",
"* [Use second person](https://developers.google.com/style/person)\n",
"* [Use contractions](https://developers.google.com/style/contractions)\n",
"* [Use active voice](https://developers.google.com/style/voice)\n",
"* [Use sentence case](https://developers.google.com/style/capitalization)\n",
"\n",
"## Building the Ray documentation\n",
"\n",
"If you want to contribute to the Ray documentation, you'll need a way to build it.\n",
Expand Down Expand Up @@ -168,18 +180,15 @@
"snippets, read [How to write code snippets](writing-code-snippets).\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": null,
"id": "ba88d95f",
"metadata": {},
"metadata": {
"vscode": {
"languageId": "python"
}
},
"outputs": [],
"source": [
"# __function_api_start__\n",
Expand Down Expand Up @@ -311,7 +320,10 @@
"metadata": {
"tags": [
"hide-cell"
]
],
"vscode": {
"languageId": "python"
}
},
"outputs": [],
"source": [
Expand Down Expand Up @@ -373,7 +385,11 @@
"cell_type": "code",
"execution_count": null,
"id": "8412103e",
"metadata": {},
"metadata": {
"vscode": {
"languageId": "python"
}
},
"outputs": [],
"source": [
"num_workers = 8\n",
Expand Down

0 comments on commit a23ef5f

Please sign in to comment.