Add numpydoc validation hook and fix f-string syntax #546
Conversation
Thank you for the pull request!The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :) If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you! Maintainer checklist |
| @@ -81,14 +81,14 @@ | |||
| ) | |||
| language_db_dict["translation"]["full_path_to_scribe_ios_db"] = ( | |||
| PATH_TO_SCRIBE_DATA_ROOT.parent | |||
| / f"{language_db_dict["translation"]['scribe_ios_db_path']}" | |||
| / f"{language_db_dict['translation']['scribe_ios_db_path']}" | |||
There was a problem hiding this comment.
Great catch on these, @Ktyby21! Thanks for this :)
There was a problem hiding this comment.
Really great to have this on the project, @Ktyby21! Looking forward to our docstrings improving because of it 😊
Contributor checklist
pytestcommand as directed in the testing section of the contributing guideDescription
This PR introduces the numpydoc-validation pre-commit hook to enforce consistent docstring styles in the project. The hook has been configured to validate all Python files, excluding the tests directory.
Additionally, this PR includes fixes for:
1. f-string syntax issues in send_dbs_to_scribe.py to ensure proper string formatting.
2. Adjustments to make the code compliant with the new validation requirements.
Changes
• Added numpydoc-validation to .pre-commit-config.yaml.
• Fixed unmatched brackets in f-strings in send_dbs_to_scribe.py.
Testing
• Ran pre-commit locally to ensure the hook works and validates docstrings correctly.
• Verified that all f-string-related issues have been resolved.
Related issue