Jira (PDOC-271) unicode space causes oddly formatted output / missing text

0 views
Skip to first unread message

William Yardley (JIRA)

unread,
Dec 6, 2018, 2:06:11 PM12/6/18
to puppe...@googlegroups.com
William Yardley created an issue
 
Puppet Strings / Bug PDOC-271
unicode space causes oddly formatted output / missing text
Issue Type: Bug Bug
Assignee: Unassigned
Components: CLI
Created: 2018/12/06 11:05 AM
Priority: Major Major
Reporter: William Yardley

Ewoud Kohl van Wijngaarden noticed that https://github.com/voxpupuli/puppet-rabbitmq/blob/24abdd6b9934167d10f7ebc30fbc07cd654e6f81/manifests/init.pp#L192 had an odd unicode character that renders as a space for me (even with cat -vet) (https://github.com/voxpupuli/puppet-rabbitmq/pull/744#issuecomment-444942295 )

This seemed to be causing other weird spacing / rendering as well

od -c shows

0026020    a   d   m   i   n       f   i   l   e  \n   #      **   @   p
0026040    a   r   a   m       l   o   o   p   b   a   c   k   _   u   s
0026060    e   r   s       T   h   i   s       o   p   t   i   o   n    
 

Attached is a pretty self contained repo case, tho haven't been able to replicate the case (probably can be replicated with above config) where some examples don't get rendered. If you add a "# foo" at the top, you'll see the missing docs line end up there.
 

 

Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo

William Yardley (JIRA)

unread,
Dec 6, 2018, 2:07:02 PM12/6/18
to puppe...@googlegroups.com

Jesse Scott (JIRA)

unread,
Jun 11, 2019, 8:00:03 PM6/11/19
to puppe...@googlegroups.com
Jesse Scott commented on Bug PDOC-271
 
Re: unicode space causes oddly formatted output / missing text

Sorry for the delayed response, but this appears to be an issue in the underlying YARD gem's ability to detect documentation tags that include non-standard whitespace characters. I would suggest following up with https://github.com/lsegal/yard if this continues to be an issue for you.

Please feel free to re-open this issue if you are sure it is a problem specific to puppet-strings.

Thanks!

Reply all
Reply to author
Forward
0 new messages