-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Situation
Our code and template in etc/docbuild/env.example.toml uses keys that contain inconsistent names. For example, we have tmp_base_path (suffix "path") and tmp_build_dir (suffix "dir"). But we have also inconsistencies between prefixes like temp_repo_dir (prefix temp) and tmp_base_dir (prefix tmp).
Use Case
Naming things is the hardest part we can do. 😉 Inconsistent names make it difficult to remember and guess the correct key names.
Possible Implementation
To fix this, I would suggest:
-
Decide which suffix we use (
pathordir). -
Decide if the naming is accurate enough.
-
Search for any strings that matches the
tmp_*_(dir|path).egrep -r "tmp_[a-z_]+(dir|path)" src/docbuild tests/ docs/source/Then change it accordingly to the new rule.
-
Adapt
etc/docbuild/env.example.tomltoo as this acts as a template.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request