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

profile: standardize tutorial style #2218

Merged
merged 2 commits into from May 10, 2019

Conversation

Projects
None yet
4 participants
@wchargin
Copy link
Member

commented May 9, 2019

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:** for
consistency with the same guide).

This commit is easier to review with --word-diff.

Test Plan:
Check that all remaining **-sequences are intended:

$ 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

profile: standardize tutorial style
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
@review-notebook-app

This comment has been minimized.

Copy link

commented May 9, 2019

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

qqfish approved these changes May 9, 2019

Copy link
Contributor

left a comment

Thank you for making this change!

@lamberta
Copy link
Member

left a comment

Thanks for this! One small change

[integrate]
wchargin-branch: profile-unembolden

@wchargin wchargin requested a review from stephanwlee May 9, 2019

@wchargin wchargin merged commit c23b565 into master May 10, 2019

2 checks passed

Travis CI - Pull Request Build Passed
Details
cla/google All necessary CLAs are signed

@wchargin wchargin deleted the wchargin-profile-unembolden branch May 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.