Unify annotation names #225

Closed
FWeinb opened this Issue Sep 25, 2014 · 2 comments

Comments

Projects
None yet
2 participants
@FWeinb
Member

FWeinb commented Sep 25, 2014

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.

@FWeinb FWeinb added this to the 2.0 milestone Sep 25, 2014

@HugoGiraudel HugoGiraudel changed the title from Unify annotation names. to Unify annotation names Sep 25, 2014

@HugoGiraudel

This comment has been minimized.

Show comment
Hide comment
@HugoGiraudel

HugoGiraudel Sep 25, 2014

Member

All in favor of this.

Member

HugoGiraudel commented Sep 25, 2014

All in favor of this.

@FWeinb

This comment has been minimized.

Show comment
Hide comment
@FWeinb

FWeinb Oct 6, 2014

Member

We need to keep in mind to update sassdoc-filter too!

Member

FWeinb commented Oct 6, 2014

We need to keep in mind to update sassdoc-filter too!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment