Skip to content

Add context to "may be out of date" sections #924

Closed
@workingjubilee

Description

@workingjubilee

Many places in the guide mention "this section may be out of date", such as in the parser. This is unfortunately quite ambiguous because the writer usually has not contextualized it with a "when" or "why", and so the reader does not know how much to trust or mistrust the information. Such comments should be marked with enough data to provide a reasonable amount of context, possibly including but not limited to

  1. a reason for why the data may be out of date other than "change"... change is a constant across the project
  2. a time the comment was added (visible in git blame but not on the website)
  3. a link to a relevant WG, tracking issue, or similar, that may provide further explanation for the change process

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions