Jira (PUP-10054) Incorrect function in documentation examples for strip and rstrip functions

[Brian Krische (JIRA)]

Brian Krische created an issue

Puppet / PUP-10054 Incorrect function in documentation examples for strip and rstrip functions Issue Type: Improvement Assignee: Unassigned Components: Docs Created: 2019/09/30 7:27 AM Priority: Normal Reporter: Brian Krische In the documentation, the example usages for the functions strip and rstrip are wrong, they both seem to show usage of lstrip and not the appropriate function. strip shows usage of lstrip rstrip shows usage of lstrip Add Comment

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

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-10054

Re: Incorrect function in documentation examples for strip and rstrip functions Meh... (it also uses camelcase() in an example - which is yet another copy/paste error in there). This is the version on master: # ```puppet # " hello\n\t".lstrip() # camelcase(" hello\n\t") # ``` # Would both result in `"hello"` # # @example Removing trailing space from strings in an Array # ```puppet # [" hello\n\t", " hi\n\t"].lstrip() # lstrip([" hello\n\t", " hi\n\t"]) # ``` # Would both result in `['hello', 'hi']` # Should be changed to: # ```puppet # " hello\n\t".strip() # strip(" hello\n\t") # ``` # Would both result in `"hello"` # # @example Removing trailing space from strings in an Array # ```puppet # [" hello\n\t", " hi\n\t"].strip() # strip([" hello\n\t", " hi\n\t"]) # ``` # Would both result in `['hello', 'hi']` #

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-10054

Re: Incorrect function in documentation examples for strip and rstrip functions

And this is the master version of rstrip: # @example Removing trailing space from a String

# ```puppet # "hello\n\t".lstrip() # camelcase("hello\n\t") # ``` # Would both result in `"hello"` # # @example Removing trailing space from strings in an Array # ```puppet # ["hello\n\t", "hi\n\t"].lstrip() # lstrip(["hello\n\t", "hi\n\t"]) # ``` # Would both result in `['hello', 'hi']` #

Which should be changed to: # @example Removing trailing space from a String # ```puppet # " hello\n\t".rstrip() # rstrip(" hello\n\t")

# ``` # Would both result in `" hello"` # # @example Removing trailing space from strings in an Array # ```puppet # [" hello\n\t", " hi\n\t"].lstrip()

# rstrip([" hello\n\t", " hi\n\t"])

# ``` # Would both result in `[' hello', ' hi']` #

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg updated an issue

Puppet / PUP-10054

Incorrect function in documentation examples for strip and rstrip functions

Change By: Henrik Lindberg Issue Type: Improvement Bug

Add Comment

[Henrik Lindberg (JIRA)]

Henrik Lindberg commented on PUP-10054

Re: Incorrect function in documentation examples for strip and rstrip functions And of cource - lstrip() is also wrong: it has: # @example Removing leading space from a String # ```puppet # "\n\thello".lstrip() # camelcase("\n\thello")

# ``` # Would both result in `"hello"` #

# @example Removing leading space from strings in an Array # ```puppet # ["\n\thello", "\n\thi"].lstrip() # lstrip(["\n\thello", "\n\thi"])

# ``` # Would both result in `['hello', 'hi']` #

and should be changed to: # @example Removing leading space from a String # ```puppet # "\n\thello ".lstrip() # lstrip("\n\thello ")

# ``` # Would both result in `"hello "` #

# @example Removing leading space from strings in an Array # ```puppet # ["\n\thello ", "\n\thi "].lstrip() # lstrip(["\n\thello ", "\n\thi "])

# ``` # Would both result in `['hello ', 'hi ']` #

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper updated an issue

Puppet / PUP-10054

Incorrect function in documentation examples for strip and rstrip functions

Change By: Josh Cooper Team: Coremunity

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper updated an issue

Puppet / PUP-10054 Incorrect function in documentation examples for strip and rstrip functions

Change By: Josh Cooper Sprint: Coremunity Hopper

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper updated an issue

Puppet / PUP-10054 Incorrect function in documentation examples for strip and rstrip functions

Change By: Josh Cooper Labels: beginner

Add Comment

[Josh Cooper (JIRA)]

Josh Cooper updated an issue

Puppet / PUP-10054 Incorrect function in documentation examples for strip and rstrip functions

Change By: Josh Cooper Sprint: Coremunity Hopper

Add Comment

[Claire Cadman (Jira)]

Claire Cadman assigned an issue to Claire Cadman

Puppet / PUP-10054 Incorrect function in documentation examples for strip and rstrip functions

Change By: Claire Cadman Assignee: Claire Cadman

Add Comment

This message was sent by Atlassian Jira (v8.5.2#805002-sha1:a66f935)

[Claire Cadman (Jira)]

Claire Cadman commented on PUP-10054

Re: Incorrect function in documentation examples for strip and rstrip functions Josh Cooper Yes I'll do this next week, thanks!

Add Comment

[Claire Cadman (Jira)]

Claire Cadman updated an issue

Puppet / PUP-10054

Incorrect function in documentation examples for strip and rstrip functions

Change By: Claire Cadman Labels: beginner generated-docs

Add Comment

[Claire Cadman (Jira)]

Claire Cadman commented on PUP-10054

Re: Incorrect function in documentation examples for strip and rstrip functions Josh Cooper I've made a PR here: https://github.com/puppetlabs/puppet/pull/8266

Add Comment