profile: standardize tutorial style #2218
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary: Per @lamberta via [the Google dev docs style guide][guide], we should use sentence case for titles and headers, and “prefer italics instead bold for emphasis” because “bold style tends to conflict with the h3/h4/h5 styles that devsite uses when skimming the page”. This commit replaces strong emphasis with emphasis, quotations, or code spans, as appropriate. Strong emphasis is retained for description list items and a `**NOTE**:` specifier (changed to `**Note:**` for consistency with [the same guide][guide]). This commit is easier to review with `--word-diff`. [guide]: https://developers.google.com/style/capitalization Test Plan: Check that all remaining `**`-sequences correspond to description lists: ``` $ grep -F '**' docs/r2/tensorboard_profiling_keras.ipynb | cut -c -40 "* **CPU**: CPU events are und "* **GPU**: GPU events are und "* **TensorFlow Runtime**: Run "**NOTE**: Please don't run mult ``` wchargin-branch: profile-unembolden
|
Check out this pull request on ReviewNB: https://app.reviewnb.com/tensorflow/tensorboard/pull/2218 Visit www.reviewnb.com to know how we simplify your Jupyter Notebook workflows. |
qqfish
approved these changes
May 9, 2019
lamberta
reviewed
May 9, 2019
lamberta
approved these changes
May 9, 2019
wchargin-branch: profile-unembolden
stephanwlee
approved these changes
May 10, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Per @lamberta via the Google dev docs style guide, we should
use sentence case for titles and headers, and “prefer italics instead
bold for emphasis” because “bold style tends to conflict with the
h3/h4/h5 styles that devsite uses when skimming the page”.
This commit replaces strong emphasis with emphasis, quotations, or code
spans, as appropriate. Strong emphasis is retained for description list
items and a
**NOTE**:specifier (changed to**Note:**forconsistency with the same guide).
This commit is easier to review with
--word-diff.Test Plan:
Check that all remaining
**-sequences are intended:wchargin-branch: profile-unembolden