docs icon indicating copy to clipboard operation
docs copied to clipboard

Improve markdown formatting for better readability

Open sepehr21ar opened this issue 4 months ago • 1 comments

This PR improves the formatting of markdown files across the repository.

  • Standardized headings and bullet points.
  • Fixed inconsistent spacing and line breaks.
  • Improved readability for contributors and new readers.

sepehr21ar avatar Aug 28 '25 20:08 sepehr21ar

Preview

Preview and run these notebook edits with Google Colab: Rendered notebook diffs available on ReviewNB.com.

Format and style

Use the TensorFlow docs notebook tools to format for consistent source diffs and lint for style:
$ python3 -m pip install -U --user git+https://github.com/tensorflow/docs

$ python3 -m tensorflow_docs.tools.nbfmt notebook.ipynb
$ python3 -m tensorflow_docs.tools.nblint --arg=repo:tensorflow/docs notebook.ipynb
If commits are added to the pull request, synchronize your local branch: git pull origin master

github-actions[bot] avatar Aug 28 '25 20:08 github-actions[bot]