Add docstring checker in Workflow

[BoSmallEar]

What changes do you make in this PR?

Add docstring checker for metadrive
Probably we could merge this PR after all the docstrings are implemented

• Please describe why you create this PR

Checklist

• I have merged the latest main branch into current branch.
• I have run bash scripts/format.sh before merging.
• Please use "squash and merge" mode.

[pengzhenghao]

Do we have any tool to auto generate the template of the docstring?

[pengzhenghao]

What does this mean? Is it expected?

[BoSmallEar]

shoud work now, we should also define a threshold on how much coverage improvement could be defined as "passed", currently as long as the ci would pass as long as there is any improvment

[pengzhenghao]

I think that’s not the case. We should require the doctoring coverage to be non-decreasing. Instead of asking for improvement in each PR. Best, Zhenghao

…

On Oct 19, 2023, at 7:26 PM, Zhizheng Liu ***@***.***> wrote: shoud work now, we should also define a threshold on how much coverage improvement could be defined as "passed", currently as long as the ci would pass as long as there is any improvment — Reply to this email directly, view it on GitHub <#518 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AFJNUE7AST6YNVB2CL4I52DYAHOLVAVCNFSM6AAAAAA6H7ZBZKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONZRHE3TMNBWGQ>. You are receiving this because your review was requested.

[BoSmallEar]

I totally agree, but isn't the goal of this PR to encourage the coverage little by little after each PR? We could also set a minimum coverage and if the final coverage is greater than this we won't check how the coverage changes from the main branch

[pengzhenghao]

I think current one is more practical like a real CI test.

The one you are saying like a little game, which might not be suitable to written into the CI workflow. We can just having several PR to increase the coverage while this might not be reflected as a pass flag in CI. After all the coverage improvement is just a short-term campaign

[BoSmallEar]

Yes, that's like an incentive to encourage more docstrings.
No problem, the way you're doing is also completely fine and we just need to setup some plans for improving the docstrings

[github-actions]

message

[BoSmallEar]

message

that's cool stuffs lol

[github-actions]

${message}

[github-actions]

Docstring coverage check successful! You have changed the coverage from 26.832618025751074 to 26.832618025751074 by 0.

[github-actions]

Docstring coverage check successful! You have changed the coverage from 0.000% to 0.000% by 0%.

[github-actions]

You have changed the docstring coverage from 26.833% to 26.833% by 0%.

[github-actions]

[BOT] Great job! You have changed the docstring coverage from 26.833% to 26.833% by 0%.