[tools] Add a docstring check to the pre-commit #2444
Conversation
Signed-off-by: sarfaraz siddiqui <sarfarazsiddiqui199@gmail.com>
Signed-off-by: sarfaraz siddiqui <sarfarazsiddiqui199@gmail.com>
Signed-off-by: sarfaraz siddiqui <sarfarazsiddiqui199@gmail.com>
Signed-off-by: sarfaraz siddiqui <sarfarazsiddiqui199@gmail.com>
Signed-off-by: sarfaraz siddiqui <sarfarazsiddiqui199@gmail.com>
Signed-off-by: gabrieldemarmiesse <gabrieldemarmiesse@gmail.com>
Signed-off-by: gabrieldemarmiesse <gabrieldemarmiesse@gmail.com>
Signed-off-by: gabrieldemarmiesse <gabrieldemarmiesse@gmail.com>
Signed-off-by: gabrieldemarmiesse <gabrieldemarmiesse@gmail.com>
There was a problem hiding this comment.
Generally looks good! Just a few quibbles. Thanks for working on this and continuing on the work from @sarfarazsiddiquii!
stdlib/docs/style-guide.md
Outdated
|
|
||
| Mojo provides a command line utility, `mojo doc`, to validate the API doc strings in your code. | ||
| This ensures that your doc strings are correctly formatted and consistent with the Mojo style guidelines. | ||
| Not that you should not have any warnings. |
stdlib/scripts/check-docstrings.py
Outdated
| # ===----------------------------------------------------------------------=== # | ||
|
|
||
| import subprocess | ||
| from pathlib import Path |
There was a problem hiding this comment.
Suggestion I think this import is unused: remove it.
Signed-off-by: gabrieldemarmiesse <gabrieldemarmiesse@gmail.com>
|
Do you mind rebasing to fix conflicts, please? |
|
|
Weird. I'll take a look at it. I can force import this PR anyways and see if there any conflicts, but even the GH UI is showing conflicts. |
|
I still have no conflicts on my UI. If you use incognito mode to go on the web page, does it still shows the conflicts? |
|
Something seems a bit odd as discussed upthread. There's also an issue with this branch where it doesn't contain any copybara base since it hasn't been rebased with |
|
Closing in favor of #2483 which is imported internally and set to merge soon. |
Follow up on #2343
Fix #2331
This will run automatically in the CI and for contributors using pre-commit :)
Thanks for your work on it @sarfarazsiddiquii ! The commits of your PR are included here