Jira (PDOC-288) markdown summary uses too much summary text and truncates

2 views
Skip to first unread message

Henrik Lindberg (JIRA)

unread,
Aug 18, 2019, 5:54:03 AM8/18/19
to puppe...@googlegroups.com
Henrik Lindberg created an issue
 
Puppet Strings / Bug PDOC-288
markdown summary uses too much summary text and truncates
Issue Type: Bug Bug
Assignee: Unassigned
Created: 2019/08/18 2:53 AM
Priority: Normal Normal
Reporter: Henrik Lindberg

The summary / index for functions that is generated when producing markdown contains too much text and truncates it.

For example:

tahu::attributes: Returns the instance attributes of an Object or Type. An instance attribute is an attribute of a value. Only Object values have inst

For documentation that looks like this:

# Returns the instance attributes of an `Object` or `Type`.
#
# An *instance attribute* is an attribute of a value. Only `Object` values have
# instance attributes; for example the `name` of a `Person`. Contrast this
# with a *type attribute* which is an attributes of a `Type`. The type attributes

I expected that it would only use only the first sentence, or at least stop at the first blank line.

Add Comment Add Comment
 
This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)
Atlassian logo
Reply all
Reply to author
Forward
0 new messages