search

SATVILab / projr

Streamline R projects
https://satvilab.github.io/projr/
Other
1 stars 1 forks source link

Consider whether the underscore in front of the directory paths by default is not confusing #532

Closed MiguelRodo closed 3 months ago

MiguelRodo commented 3 months ago

Apparently (according to Google Gemini), it has an assocation with hidden files and folders? I guess that makes sense, as _bookdown is hidden...

MiguelRodo commented 3 months ago

Final decision

The final decision is to keep using underscores to (by default) prefix directoriy paths like _data_raw, _tmp, and _output.

This decision was made due to the following reasons:

  1. Visual Distinction: Underscores effectively set these directories apart from your main code directories.
  2. Sorting: Underscores help in sorting these directories in file managers and IDEs.
  3. Convention: Underscores align with the established practices of popular static site generators like Jekyll and Hugo.

While there are some potential downsides to using underscores, such as the association with hidden files, the benefits of clarity and consistency outweigh the drawbacks in this scenario.