correct documentation

[BenTheElder]

What this PR does / why we need it: Fixes the documentation for .*ln functions. These erroneously stated that a newline is added if missing, but internally they use fmt.Fprintln which always appends a '\n' after the arguments.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer: https://golang.org/pkg/fmt/#Fprintln

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

NONE

[k8s-ci-robot]

Welcome @BenTheElder!

It looks like this is your first PR to kubernetes/klog 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/klog has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[BenTheElder]

/assign @justinsb

[andyxning]

/lgtm

[justinsb]

Thanks @BenTheElder

I tried to figure out what happened. These look like copy-and-pasted comments; the comments are correct on the other methods, but were incorrect on *ln methods.

I also agree that we should simple fix the comment instead of changing the behaviour; the behaviour that we have today seems reasonable (even though Println feels relatively redundant ...)

/lgtm

[justinsb]

Ah - you already have lgtm; have an approve then!

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andyxning, BenTheElder, justinsb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [justinsb]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[BenTheElder]

thanks! :-)

yeah these functions have quite a bit of overlap but ... 🤷‍♂

who knows how existing code is depending on this