[jira] [Work logged] (BEAM-13125) [Playground] Update documentation for environments

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

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

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

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



##########
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:
       why is it that we can have multiple cacheEnvs?

##########
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:
       ```suggestion
   	// this is a string with hostname:port of the cache server for redis caches
   ```

##########
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:
       ```suggestion
   	// workingDir is a root working directory of application..
   	// This directory is different from the `pwd` of the application. It is a working directory passed as
   	// a parameter where the application stores code, executables, etc.
   ```
   
   Let me know if this is correct, and if it is, feel free to apply it? : )




-- 
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: 672961)
    Time Spent: 0.5h  (was: 20m)

> [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: 0.5h
>  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)