Skip to content
This repository was archived by the owner on Jul 30, 2019. It is now read-only.
This repository was archived by the owner on Jul 30, 2019. It is now read-only.

ASCII art in source files is not helpful #1201

@chaals

Description

@chaals

The source files generally start with a giant ASCII art version of the name, in a comment.

It is not always legible, and in any event it doesn't provide much in the way of value. It would be more helpful to describe the source file, what it contains, and where it ends up in the spec, for example

<!--
This is the source file for https://w3c.github.io/html/introduction.html

All the content is "non-normative". It contains
- a background / potted history of HTML
- a few design notes
- a note on HTML and XML syntax
- information on how the spec is written and how to read it
- some privacy considerations
- an introduction to HTML itself, how to write it, etc.
- non-normative conformance requirements for content
- links to some other specs: charmod, unicode security, and some accessibility specs
-->
  • acknowledgements.include
  • attributes.include
  • browsers.include
  • changes.include
  • dom.include
  • editing.include
  • element-content-categories.include
  • element-interfaces.include
  • elements.include
  • events.include
  • iana.include
  • infrastructure.include
  • introduction.include
  • obsolete.include
  • rendering.include
  • semantics-common-idioms.include
  • semantics-document-metadata.include
  • semantics-edits.include
  • semantics-embedded-content.include
  • semantics-forms.include
  • semantics-grouping-content.include
  • semantics.include
  • semantics-interactive-elements.include
  • semantics-links.include
  • semantics-root.include
  • semantics-scriptings.include
  • semantics-sections.include
  • semantics-tabular-data.include
  • semantics-textlevel.include
  • syntax.include
  • webappapis.include
  • xhtml.include

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions