Skip to content

Unify annotation names #225

@FWeinb

Description

@FWeinb

Currently we have these core annotations in SassDoc:

  • @access
  • @alias
  • @author
  • @deprecated
  • @example
  • @group
  • @ignore
  • @link
  • @output
  • @parameters
  • @prop
  • @requires
  • @returns
  • @see
  • @since
  • @throws
  • @todos
  • @type

For 2.0.0 I would like to unify these to be all singular. So we need to rename:

  • @parameters => @parameter
  • @requires => @require
  • @returns => @return
  • @throws => @throw
  • @todos => @todo

Additionally I would like to rename @prop to @property to align it with @parameter.

We need to think about this because we won't be able to change this after 2.0.0 any time soon again, because this would break all themes.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions