Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trailing whitespace created by editor is detected Squiz.WhiteSpace.SuperfluousWhitespace.EndLine #804

Closed
snmatsui opened this issue Feb 6, 2025 · 3 comments

Comments

@snmatsui
Copy link

snmatsui commented Feb 6, 2025

LINE  22: ERROR [x] Whitespace
                    found
                    at
                    end
                    of
                    line
                    (Squiz.WhiteSpace.SuperfluousWhitespace.EndLine)
----------------------------------------------------------------------
    20:  /**
    21:  ·*·LoremIpsum
>>  22:  ·*·
    23:  ·*·LoremIpsum

PHPDocumentor requires whiteline between summary and description.
(https://docs.phpdoc.org/guide/references/phpdoc/basic-syntax.html)

It looks natural that Line22 has trailing whitespace.

@jrfnl
Copy link
Member

jrfnl commented Feb 6, 2025

@snmatsui Please consider updating the title of the issue to something more polite.

Other than that, PHPDocumentor requires a blank comment line between the summary and the description. As far as I know, they do not require that line to contain trailing whitespace and the page you linked to doesn't say so either.

@snmatsui snmatsui changed the title Stupid detection of Squiz.WhiteSpace.SuperfluousWhitespace.EndLine trailing whitespace created by editor is detected Squiz.WhiteSpace.SuperfluousWhitespace.EndLine Feb 14, 2025
@snmatsui
Copy link
Author

I am terribly sorry for my rudeness.

When writing PHPDoc comments in major editors like VSCode or PHPStorm, a trailing whitespace is automatically added on new lines.

@jrfnl
Copy link
Member

jrfnl commented Feb 14, 2025

@snmatsui That sounds to me like something which is configurable in whichever IDE you use as otherwise I would have expected lots more issues about it. I suggest having look at the settings of your IDE.

@jrfnl jrfnl closed this as not planned Won't fix, can't repro, duplicate, stale Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants