[meta] Should a leading slash denote top-level folders (/themes /modules /sites/all /core etc)

Created on 30 September 2012, almost 12 years ago
Updated 25 July 2023, about 1 year ago

The top-level README.txt is using leading slash for top level directories like /themes and /modules, apparently for clarity to distinguish a directory name reference from the plain-English word. Other references throughout the documentation and codebase comments to non-top level directories, such as sites/all, do NOT use the leading slash. The problem is that these two ways of referencing directories have never been put side-by-side, and thus never noticed in a single document until the proposed changes to sites/README.txt in #1539940-79: Encourage best practices in /sites/README.txt, /modules/README.txt, /profiles/README.txt and /themes/README.txt , where we reference the core/INSTALL.txt and the /modules and /themes folders all in one place.

Removing the leading slash in the sites/README.txt from the proposed changes in #1539940 would then make it inconsistent with the existing references to the same directories in top-level README.

We need to decide whether code-wide consistency is more important than same-file consistency, and to either standardize on the leading slash in documentation for all of core, or just go with whatever works in a local context.

Feature request
Status

Closed: won't fix

Version

9.5

Component
Documentation 

Last updated 1 minute ago

No maintainer
Created by

🇪🇨Ecuador jwilson3

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024