rosetn commented on a change in pull request #14045:
URL: https://github.com/apache/beam/pull/14045#discussion_r586082067



##########
File path: examples/notebooks/tour-of-beam/reading-and-writing-data.ipynb
##########
@@ -0,0 +1,939 @@
+{
+  "nbformat": 4,
+  "nbformat_minor": 0,
+  "metadata": {
+    "colab": {
+      "name": "Reading and writing data -- Tour of Beam",

Review comment:
       General note about this notebook: consider using text formatting more 
discerningly. Overusing text formatting will cause the formatting to lose the 
additional context and might make sentences more difficult to comprehend. 
   
   * If you're using italics to define terms, don't italicize words that you're 
not trying to define or explain. I'm actually a little confused about why some 
terms are italicized; it could be possible that you're trying to make a new 
user aware of important terms. However, pulling these terms out in a bulleted 
list to highlight them or naming your headers in a way to direct attention to 
the term might be a better choice.
   * On a similar note with bolding terms, I'm not sure why Source and Sink are 
bolded. 
   * Here are some general guidelines: 
https://developers.google.com/style/text-formatting. We don't need to follow 
them strictly, but we should be deliberate in our choices.




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


Reply via email to