[DOCS] Add pre-commit hook `check-docstring-first` - Githubissues

apache / sedona

A cluster computing framework for processing large-scale geospatial data

https://sedona.apache.org/

Apache License 2.0

1.96k stars 692 forks source link

[DOCS] Add pre-commit hook `check-docstring-first` #1604

Closed jbampton closed 1 month ago

jbampton commented 1 month ago

https://github.com/pre-commit/pre-commit-hooks?tab=readme-ov-file#check-docstring-first

Did you read the Contributor Guide?

Yes, I have read the Contributor Rules and Contributor Development Guide

Is this PR related to a JIRA ticket?

No, this is a documentation update. The PR name follows the format [DOCS] my subject.

What changes were proposed in this PR?

Adds another check/test to our pre-commit framework.

How was this patch tested?

Ran locally:

pre-commit run --all-files

Did this PR include necessary documentation updates?

No, this PR does not affect any public API so no need to change the documentation.