Feature request: remove trailing '-' from options if no additional documentation is added #522

Closed
ferrous26 opened this Issue Apr 29, 2012 · 0 comments

Comments

Projects
None yet
2 participants

I have a project where I have documented options like so:

  # @param [Hash] opts
  # @option opts [NSColor] :colour (NSColor.magentaColor)

And the :colour option generates the following string in the web view:

:colour (NSColor) — default: NSColor.magentaColor —

I have not included any extra documentation for the :colour option but there is still a trailing "-" character. To me it looks strange and I think it would be better if it were note there.

lsegal closed this in e449d76 May 1, 2012

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