This help site has been deprecated. Please send your requests to

Could I add proper markup discovery for the description?

Mauro's Avatar


08 Aug, 2020 10:25 AM

See the google groups for a full description:


Hello, I wanted to discuss a possible change I will gladly add via a PR to add ability to have formatted description.

Currenly only RDoc Markup seems supported (see RubygemsHelper#simple_markup) and only detected if the first line starts with a header markup (e.g. `==`). I was thinking using the metadata to communicate in what format the description has been written, something among this lines:

  s.metadata = {
    'description_markup_format' => 'rdoc',

To sum up:
- agree on what metadata key name to use, my proposal: "description_markup_format"
- document the metadata key name and the supported formats
- make ruby gems support the standardised formats via the agreed metadata key name

Ideas? Feedback?

I'll be happy to work on this if you think it could be a good addition

  1. Support Staff 1 Posted by sonalkr132 on 31 Aug, 2020 05:18 AM

    sonalkr132's Avatar

    Hi Mauro,

    Sorry about the delay in response. Unfortunately, the google group is not as active anymore. I would suggest opening a feature request on
    Please add your use-case as well. If the issue gains traction we go ahead with the implementation.

  2. sonalkr132 closed this discussion on 31 Aug, 2020 05:18 AM.

Discussions are closed to public comments.
If you need help with please start a new discussion.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac