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

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

                Author: ASF GitHub Bot
            Created on: 02/Nov/21 21:46
            Start Date: 02/Nov/21 21:46
    Worklog Time Spent: 10m 
      Work Description: AydarZaynutdinov commented on a change in pull request 
#15842:
URL: https://github.com/apache/beam/pull/15842#discussion_r740852132



##########
File path: playground/backend/internal/environment/application.go
##########
@@ -38,8 +38,13 @@ func (serverEnvs NetworkEnvs) Address() string {
 
 //CacheEnvs contains all environment variables that needed to use cache
 type CacheEnvs struct {
-       cacheType         string
-       address           string
+       // cacheType is type of cache (local/redis)
+       cacheType string
+
+       // address of where the cache is running

Review comment:
       Changed.

##########
File path: playground/backend/internal/environment/application.go
##########
@@ -69,8 +74,13 @@ func NewCacheEnvs(cacheType, cacheAddress string, 
cacheExpirationTime time.Durat
 
 //ApplicationEnvs contains all environment variables that needed to run 
backend processes
 type ApplicationEnvs struct {
-       workingDir             string
-       cacheEnvs              *CacheEnvs
+       // workingDir is a root working directory of application

Review comment:
       Changed.

##########
File path: playground/backend/internal/environment/application.go
##########
@@ -69,8 +74,13 @@ func NewCacheEnvs(cacheType, cacheAddress string, 
cacheExpirationTime time.Durat
 
 //ApplicationEnvs contains all environment variables that needed to run 
backend processes
 type ApplicationEnvs struct {
-       workingDir             string
-       cacheEnvs              *CacheEnvs
+       // workingDir is a root working directory of application
+       workingDir string
+
+       // cacheEnvs contains environments for cache

Review comment:
       No, we can have only one `cacheEnvs` which contains several `environment 
variables` (not several `environments`). Updated this comment.




-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


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

    Worklog Id:     (was: 674155)
    Time Spent: 1h 50m  (was: 1h 40m)

> [Playground] Update documentation for environments
> --------------------------------------------------
>
>                 Key: BEAM-13125
>                 URL: https://issues.apache.org/jira/browse/BEAM-13125
>             Project: Beam
>          Issue Type: Improvement
>          Components: beam-playground
>            Reporter: Aydar Zaynutdinov
>            Assignee: Aydar Zaynutdinov
>            Priority: P3
>              Labels: beam-playground-backend, beam-playground-sprint-3
>          Time Spent: 1h 50m
>  Remaining Estimate: 0h
>
> Add documentation for each entity/methodĀ for environments so that maintainers 
> can easily read the code in the future.



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

Reply via email to