beam-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (Jira)" <j...@apache.org>
Subject [jira] [Work logged] (BEAM-12513) Complete Go SDK inclusion to Beam Programming Guide
Date Fri, 25 Jun 2021 21:15:00 GMT

     [ https://issues.apache.org/jira/browse/BEAM-12513?focusedWorklogId=615216&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-615216
]

ASF GitHub Bot logged work on BEAM-12513:
-----------------------------------------

                Author: ASF GitHub Bot
            Created on: 25/Jun/21 21:14
            Start Date: 25/Jun/21 21:14
    Worklog Time Spent: 10m 
      Work Description: lostluck commented on pull request #15057:
URL: https://github.com/apache/beam/pull/15057#issuecomment-868836843


   > > R: @youngoli @tysonjh
   > > Question: What do you think of me consolidating the code example files a bit?
I think they should probably not get larger than ~400 lines each, but the small ones are certainly
too small. I'm thinking consolidating roughly on size so all the earlier sections would be
in pipeline.go, transforms.go would cover section 4, etc.
   > 
   > This makes sense to me. Does this impact how it will be displayed in docs? E.g. using
github snippets
   
   If one looked at the GoDoc for the snippet package, no that wouldn't display correctly
at all. GoDoc doesn't take file ordering into account everything is sorted by top level name
(so methods are grouped with their type as you'd expect). I don't know about github snippets.
   
   As for using those snippets in the beam website, the snippets are file origin agnostic,
and copied at static site generation, so how they're stored in code doesn't matter. 
   
   Overall, the code organization is largely cosmetic for the code itself, so the present
approach of prefixing with BPG section number means the files will be in the order that match
the section whose code they contain. Everything internally is magic comments for the code
snippet puller.


-- 
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.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

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


Issue Time Tracking
-------------------

    Worklog Id:     (was: 615216)
    Time Spent: 4h 20m  (was: 4h 10m)

> Complete Go SDK inclusion to Beam Programming Guide
> ---------------------------------------------------
>
>                 Key: BEAM-12513
>                 URL: https://issues.apache.org/jira/browse/BEAM-12513
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-go
>            Reporter: Robert Burke
>            Assignee: Robert Burke
>            Priority: P2
>          Time Spent: 4h 20m
>  Remaining Estimate: 0h
>
> BPG Go Audit snapshot: [https://docs.google.com/spreadsheets/d/1DrBFjxPBmMMmPfeFr6jr_JndxGOes8qDqKZ2Uxwvvds/edit?resourcekey=0-tVFwcLrQ2v2jpZkHk6QOpQ#gid=2072310090]
> Goal is to include Go SDK code for all missing snippets, and where code can't yet exist,
file and link a Jira instead.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Mime
View raw message