Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Too long to read for a variable #3

Closed
jacobkim9881 opened this issue Sep 12, 2022 · 5 comments
Closed

Too long to read for a variable #3

jacobkim9881 opened this issue Sep 12, 2022 · 5 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jacobkim9881
Copy link
Owner

jacobkim9881 commented Sep 12, 2022

Briefing

Variable and parameter names of recusion function are too long to read and the names should be edited into shorter and more readable name.

Problem

The variable and parameter names arrayOfStringsWithTagPath at line 26 ./src/index.js and at addStr function in ./src/utils.js are too long to read.

Objective

The variable and parameter names arrayOfStringsWithTagPath should have shorter and more readable name.

What is a role the variable

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 every keys and values of the json file should be parsed by recursion. After recursion function, each key path from the root key is pushed into an array arrayOfStringsWithTagPath. So the output array of the recursion function is arrayOfStringsWithTagPath. This variable is put into addStr function and repeated by recursion.

To do

  • Fork this repository of refact branch.
  • Install npm modules at your fork.
  • Edit variable name arrayOfStringsWithTagPath at line 26 ./src/index.js
  • Edit parameter name arrayOfStringsWithTagPath and at addStr function 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.
@jacobkim9881 jacobkim9881 added help wanted Extra attention is needed good first issue Good for newcomers invalid This doesn't seem right and removed invalid This doesn't seem right labels Sep 12, 2022
@Niravprajapati1
Copy link

Niravprajapati1 commented Sep 12, 2022

Can you suggest a variable name ?

@jacobkim9881
Copy link
Owner Author

@Niravprajapati1 It may be name with tag path. The keys in local_obj.json has tag paths.

@Niravprajapati1
Copy link

Can you share some examples?

@jacobkim9881
Copy link
Owner Author

jacobkim9881 commented Sep 24, 2022

@Niravprajapati1 I am sorry the issue is solved and closed before giving you any guidance. There is other issue and could you give any advice or take the issue to solve?

@Niravprajapati1
Copy link

@jacobkim9881 sure 😁

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants