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

Make use of the word “output” less confusing #78

Open
kordwarshuis opened this issue Jan 26, 2025 · 1 comment
Open

Make use of the word “output” less confusing #78

kordwarshuis opened this issue Jan 26, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request

Comments

@kordwarshuis
Copy link

  • What: Avoid multiple uses of the word “output”
  • Why: It is confusing since it is used in two ways
  • Who: Confusing for the programmer
  • When: asap
  • What way: refactor code

Make use of the word “output” less confusing. Currently in specs.json we have:

1:

"output_path": "./docs"

So the output path can be configured to a name to your liking (as long as it does not exist in the root dir)

"output_path" has variables created from that entry with “output” in them.

2:

At the same time we have a “system directory” that is called output/ (not configurable), where all files created by the Node.js scripts are saved.

==>
This is confusing, one of the two has to change.
Preferably output/, to something better, like system-generated/

@kordwarshuis kordwarshuis added the enhancement New feature or request label Jan 26, 2025
@kordwarshuis kordwarshuis self-assigned this Jan 26, 2025
@kordwarshuis
Copy link
Author

Search for the following in the code base:
output path
outputPath

New strings will be added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant