Ruby documentation comments formatting

[RobertAudi]

The documentation comments in the code are in the markdown format but are generated on a single line, which makes it unreadable and unparsable using markdown or rubydoc.info.

One example is the #create_envelope method (rubydoc).

The documentation comments are the only source of documentation that I found for the ruby client, and this issue makes it really hard to work with.

[LarryKlugerDS]

Hi Robert! We hear you! We have a project underway to create SDK-specific documentation. The first project's first outcome is our C# part 1 docs. Ruby is on the list but will be much later in the year since we're proceeding in order of the SDKs' popularity.

Regards, Larry

[RobertAudi]

@LarryKlugerDS I believe the docs and code is generate by Swagger. Would is be possible in the meantime to fix the generation config to add newlines in the documentation comments so that it could be parsable using markdown? 🤔

[LarryKlugerDS]

Thank you for the idea. I have filed it as DCM-5284. Unfortunately we have a limited engineering staff. But we'll see how it goes.

[aturkewi]

I'd like to +1 this.

It's been almost 9 months and the create_envelope documentation is still unreadable. Is there a timeline for a fix? Or an alternate location (besides here https://www.rubydoc.info/github/docusign/docusign-ruby-client/master/DocuSign_eSign/EnvelopesApi#create_envelope-instance_method) where this is readable? I'm trying to get up to speed on using this gem and it's a bit difficult.