Skip to content

Too long to read for a variable name #10

Description

@jacobkim9881

Briefing

A name of loop function are too long to read and the name should be edited into shorter and more readable name.

Problem

The function name of makeKeyPathReturnSrc at line 36 ./src/index.js and makeKeyPathReturnSrc function at line 92 in ./src/utils.js are too long to read.

Objective

The function name makeKeyPathReturnSrc should have shorter and more readable name.

What is a role of the function

makeKeyPathReturnSrc adds all values of a target json object into one string variable srcStr. Specifically the function loops the array tagPathStrings and gather all values up into the string variable by the loop function.

What is a role of the function for the repository

This repo changes .json files into translated .json files by helping Google translate API(If you want to how the repository works then go to README.md. To translate the .json file, all the values of the json object are added up into one string srcStr by The function makeKeyPathReturnSrc.

To do

  • Fork this repository of srt-var branch.
  • Install npm modules at your fork.
  • Edit the function name makeKeyPathReturnSrc at line 36 ./src/index.js.
  • Edit the function name makeKeyPathReturnSrc function at line 92 in ./src/utils.js.
  • Test if the fork is working by executing ./exe.sh local_obj.json at ./.
  • If error occurs fix.
  • If no error ask pull request to srt-var branch.

Examples

This issue was for getting help from GitHub community, so most of variable names from contributors are accepted first. But for any contributor who want to help with assistant, some examples might be used below.

  • addUpSource
  • stackStrings
  • gatherAllValue
  • addValue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions