mill icon indicating copy to clipboard operation
mill copied to clipboard

Strange handling of linebreaks

Open erunion opened this issue 5 years ago • 0 comments

/**
 * This method gives multiple users permission to view the specified private video. The body of the request should
 * follow our [batch request format](https://developer.vimeo.com/api/common-formats#working-with-batch-requests): each
 * object must contain a single uri field whose value is the URI of the user who can view the video.
 *
 * @api-label Permit a list of users to view a private video
 * @api-operationId add_video_privacy_users
 * @api-group Videos\Viewing privacy
 *
 * @api-path:public /videos/!clip_id/privacy/users
 * @api-path:public:alias /channels/+channel_id/videos/!clip_id/privacy/users
 * @api-pathParam channel_id `927` (integer) - The ID of the channel.
 * @api-pathParam clip_id `258684937` (integer) - The ID of the video.
 *
 * @api-contentType application/vnd.vimeo.user+json
 * @api-scope edit
 *
 * @api-return:public {collection} \Api\Response\UserResponse The users can now view the private video.
 */

When compiled, Mill is currently translating the line break in the summary into \n:

description: "This method gives multiple users permission to view the specified private video. The body of the request should\nfollow our batch request format: each\nobject must contain a single uri field whose value is the URI of the user who can view the video."

Ideally, single linebreaks in summaries and parameter descriptions would be replaced with a single space, and double linebreaks would remain as \n\n.

erunion avatar May 13 '19 01:05 erunion