docs: adopt nbfmt.py formatting, enforced in CI
#3455
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
This is expected to fail as written.
It was always a bit brittle, and is now conflicting with `nbfmt.py`. This test has been valuable maybe once, whereas `nbfmt.py` would have been valuable on nearly every docs change. `nbfmt.py` wins.
Generated with: ``` $ git ls-files -z '*.ipynb' | xargs -0 python3 ./nbfmt.py --ignore_warn Notebook: docs/get_started.ipynb Notebook: docs/graphs.ipynb Notebook: docs/hyperparameter_tuning_with_hparams.ipynb Notebook: docs/image_summaries.ipynb Notebook: docs/migrate.ipynb Removed the existing output cells. Notebook: docs/scalars_and_keras.ipynb Notebook: docs/tbdev_getting_started.ipynb Notebook: docs/tensorboard_in_notebooks.ipynb Notebook: docs/tensorboard_profiling_keras.ipynb Notebook: tensorboard/plugins/mesh/Mesh_Plugin_Tensorboard.ipynb Missing license: #@title Licensed under the Apache License Missing copyright: Copyright 20[1-9][0-9] The TensorFlow\s.*?\s?Authors ``` Test Plan: Running `git ls-files -z '*.ipynb' | xargs -0 ./nbfmt.py --test` passes.
This comment has been minimized.
This comment has been minimized.
bileschi
reviewed
Mar 31, 2020
| pip install absl-py | ||
| chmod +x ./nbfmt.py | ||
| - name: 'Check Colab notebooks for formatting' | ||
| run: git ls-files -z '*.ipynb' | xargs -0 ./nbfmt.py --test |
There was a problem hiding this comment.
like the preventative work here to avoid quoted fns
There was a problem hiding this comment.
Yep! I generally try to be funnynames-safe when it’s not too
inconvenient, and in most cases it’s easy enough.
bileschi
approved these changes
Mar 31, 2020
bileschi
pushed a commit
to bileschi/tensorboard
that referenced
this pull request
Apr 15, 2020
Summary: Notebook formatting is a frequent source of friction in pull requests, due to spurious diffs and unintended changes. @lamberta’s `nbfmt.py` is an opinionated autoformatter that should resolve these issues entirely. Test Plan: A test run of the CI change fails before the reformat and passes after: - <https://github.com/tensorflow/tensorboard/runs/549352035> - <https://github.com/tensorflow/tensorboard/runs/549365513> Both the failure and passing cases have nice output. wchargin-branch: docs-nbfmt
bileschi
pushed a commit
that referenced
this pull request
Apr 15, 2020
Summary: Notebook formatting is a frequent source of friction in pull requests, due to spurious diffs and unintended changes. @lamberta’s `nbfmt.py` is an opinionated autoformatter that should resolve these issues entirely. Test Plan: A test run of the CI change fails before the reformat and passes after: - <https://github.com/tensorflow/tensorboard/runs/549352035> - <https://github.com/tensorflow/tensorboard/runs/549365513> Both the failure and passing cases have nice output. wchargin-branch: docs-nbfmt
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:
Notebook formatting is a frequent source of friction in pull requests,
due to spurious diffs and unintended changes. @lamberta’s
nbfmt.pyisan opinionated autoformatter that should resolve these issues entirely.
Test Plan:
A test run of the CI change fails before the reformat and passes after:
Both the failure and passing cases have nice output.
wchargin-branch: docs-nbfmt