Skip to content

What is the best way to document classes, options, etc.? #1

@mrwweb

Description

@mrwweb

Currently all information about optional classes, inline styles, alignments, etc. is included in a comment preceding the block's CSS selectors. Here's the most verbose example:

/*
 * Button
 *
 * Note: Buttons container added in WP5.4
 *
 * Alignments: alignleft, aligncenter, alignright
 * Default Style Variations: is-style-outline
 * Possible Inline Styles: border-radius
 * Color Support: Background, Text
 */

Some questions I would love feedback on:

  1. Is this the best possible way to do this?
  2. Is any information missing or unclear?
  3. What would be a better way?

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions