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

False positive MISSING_KDOC_ON_FUNCTION on local function (function inside another function) #1773

Closed
DrAlexD opened this issue Nov 2, 2023 · 2 comments · Fixed by #1848
Closed
Assignees
Labels
bug Something isn't working good first issue Good for newcomers
Milestone

Comments

@DrAlexD
Copy link
Member

DrAlexD commented Nov 2, 2023

Warning MISSING_KDOC_ON_FUNCTION is thrown for functions printHello() and printBye():

    fun printHelloAndBye() {
        fun printHello() {
            print("Hello")
        }
        printHello()
        val ab = 5
        ab?.let {
            fun printBye() {
                print("Bye")
            }
            printBye()
        }
    }
@DrAlexD DrAlexD added bug Something isn't working good first issue Good for newcomers labels Nov 2, 2023
@DrAlexD DrAlexD changed the title False positive MISSING_KDOC_ON_FUNCTION on local function (function inside another function). False positive MISSING_KDOC_ON_FUNCTION on local function (function inside another function) Nov 2, 2023
@DrAlexD DrAlexD assigned DrAlexD and unassigned DrAlexD Nov 2, 2023
@nulls
Copy link
Member

nulls commented Nov 2, 2023

Please provide the code example

@DrAlexD
Copy link
Member Author

DrAlexD commented Nov 2, 2023

Code example added

diphtongue added a commit that referenced this issue Dec 7, 2023
- Fixed false positive `MISSING_KDOC_ON_FUNCTION` on local function (function inside another function)
- Added warning test

Closes #1773
diphtongue added a commit that referenced this issue Dec 7, 2023
diphtongue added a commit that referenced this issue Dec 7, 2023
…nction inside another function) (#1848)

### What's done:
- Fixed false positive `MISSING_KDOC_ON_FUNCTION` on local function (function inside another function)
- Added warning tests

Closes #1773
@nulls nulls added this to the 2.0.0 milestone Dec 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers
Projects
None yet
3 participants