Problem/Motivation

In #2375673: Split Bartik's CSS into SMACSS style components we are splitting up Bartik's css into SMACSS components. Since we are not fixing any other issues, other than changing the file organisation, a follow-up issue is created to adjust the comments in the .css files.

Proposed resolution

Many of the comments in Bartik are constructed like /* ---------- Admin-specific Theming ---------- */. Instead of these headings, let's add File comments, as suggested in the CSS formatting guidelines:

/**
 * @file
 * Short description describing the file.
 *
 * The first sentence of the long description starts here and continues on this
 * line for a while finally concluding here at the end of this paragraph.
 */

Remaining tasks

- Fix #2375673: Split Bartik's CSS into SMACSS style components
- Add a file description to each file and create a patch
- Review the patch + additional fixes
- RTBC

User interface changes

- None.

API changes

- None.- None.

Comments

sqndr’s picture

sqndr commented
Title: Add file documentation to each css file. » Add file documentation to each css file
sqndr’s picture

sqndr commented
Issue summary: View changes
emma.maria’s picture

emma.maria
she/her
commented
Status: Active » Postponed

Postponing this issue as it relies on #2375673: Split Bartik's CSS into SMACSS style components being commited first.

emma.maria’s picture

emma.maria
she/her
commented
Status: Postponed » Closed (won't fix)

Setting this to Closed (wont' fix) as we are handling CSS file comment improvements within separate component issues for Bartik, to try and not get in a huge code mess.
The new splitting up of CSS was allowed to be committed without file comments so I see no huge rush to get this part complete as a self contained follow up. See Meta here #1342054: [META] Clean up templates and CSS.