You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by GitBox <gi...@apache.org> on 2020/03/12 15:51:48 UTC

[GitHub] [beam] soyrice commented on issue #11075: [BEAM-9421] Website section that describes getting predictions using AI Platform Prediciton

soyrice commented on issue #11075: [BEAM-9421] Website section that describes getting predictions using AI Platform Prediciton
URL: https://github.com/apache/beam/pull/11075#issuecomment-598263989
 
 
   This looks great. I can give it an editorial pass, but I'll wait until we have a plan to move forward re: tfx_bsl.
   
   In the meantime, here are a couple suggestions for improving the write-up:
   - Avoid "we" pronouns wherever possible (same for "let's"). Many of these sentences can be rewritten without pronouns. For instance, "you have to make" can be simplified to just "make."
   - If a pronoun is necessary, use the second person "you" to talk directly to the reader.
   - Try to keep the opening paragraphs as short and succinct as possible. Consider breaking up long paragraphs into multiple, smaller ones. This makes it easier for readers to scan the doc.
   - Introduce the code sample by explaining what it does, rather than explaining afterwards.
   
   I put together a [checklist/template for Beam patterns](https://docs.google.com/document/d/1lawWkFPDYV9ORUZbLZUxTvjG6hunyxDdR4s3tvQi6G4/edit) if you want to take a look. The PR already looks good from a content perspective, so this is just for reference :)

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services