Skip to content

chore: docstring check#599

Merged
JulesBelveze merged 11 commits intorelease/1.1.0from
chore/docstring-check
Jul 10, 2023
Merged

chore: docstring check#599
JulesBelveze merged 11 commits intorelease/1.1.0from
chore/docstring-check

Conversation

@JulesBelveze
Copy link
Copy Markdown
Contributor

@JulesBelveze JulesBelveze commented Jul 7, 2023

This PR aims at adding some simple dosctring checks as part of pre-commit hooks and CI checks

The checks are not exhaustive but they are a good starting point and we can iterate over it as we go.

@JulesBelveze JulesBelveze self-assigned this Jul 7, 2023
@JulesBelveze JulesBelveze linked an issue Jul 7, 2023 that may be closed by this pull request
@JulesBelveze JulesBelveze marked this pull request as draft July 7, 2023 09:05
@JulesBelveze
Copy link
Copy Markdown
Contributor Author

JulesBelveze commented Jul 7, 2023

@ArshaanNazir @chakravarthik27 @Prikshit7766 @RakshitKhajuria could you guys have a quick look at the classes implemented within the transform/ directory and add a 2-3 lines description on the one you implemented please? For some of them it's quite blurry what they are aiming to achieve and what the transformation correspond to.. even the difference between the transform and run methods is not straightforward 😃

We need to make it quite obvious what the difference between Fairness, Robustness, Representation, ... is

(Feel free to directly push on this branch)

@JulesBelveze JulesBelveze marked this pull request as ready for review July 8, 2023 09:26
@JulesBelveze
Copy link
Copy Markdown
Contributor Author

@ArshaanNazir @chakravarthik27 please add your review, we will improve the docstrings in a separate PR 😃

@ArshaanNazir
Copy link
Copy Markdown
Contributor

@ArshaanNazir @chakravarthik27 please add your review, we will improve the docstrings in a separate PR 😃

Looks good. Sure, for the docstrings explaining various classes, we can create another PR

@JulesBelveze JulesBelveze merged commit eb28496 into release/1.1.0 Jul 10, 2023
@JulesBelveze JulesBelveze deleted the chore/docstring-check branch July 10, 2023 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docstring sanity checks

2 participants