Apply consistent coding and documenting styling

[liyin2015]

Outline & Motivation

Without enforcing the same formatting, developers end up committing code/files that only changes formatting, making it hard to review.

Pitch

We might need a Makefile and add either the formatting here and modify the root pyproject.toml, as described in the contributor guide that commit hook is applied here.

Additional context

No response

[fm1320]

Doesn't just running the pre-commit hooks locally (black and ruff) ensure this consistency ?

[liyin2015]

Doesn't just running the pre-commit hooks locally (black and ruff) ensure this consistency ?

If that is the case, how did your pr results so many different files?

[fm1320]

I ran the pre-commit hooks on all files before committing so the changes are white spaces and formatting that the linter enforced - I only modified one file in my PR

[liyin2015]

there is no black and ruff config in the pyproject.toml. Maybe your configuration and the others somehow end up being different. Ill add a simple version and you can rebase on this, and try to use the format and test if those files can be set back

[liyin2015]

https://github.com/SylphAI-Inc/AdalFlow/pull/274/files

[liyin2015]

Feel free to review, merge and test it on your side

You can use make setup and make format, make lint etc

[fm1320]

Yes I assumed that the fact that they were part of the .pre-commit-config.yaml means they are enforced. I will have a look

[fm1320]

I ran the pre-commit hooks suggested on all files, made the changes 3196631. Maybe this can be merged and then the styling will be consistent ? @liyin2015

[liyin2015]

• Three files need further improvement so that we can enforce pre-commit check on formatting and linting. (1) Makefile (2) pyproject.toml on the relevant confi (3).pre-commit-config.yaml