Repo checks: check documented methods exist#32320
Conversation
utils/check_repo.py
Outdated
There was a problem hiding this comment.
we've changed the model structure since 4 years ago, when this list was first created: transformers.models exclusively contains folders with models.
As such, we don't need to manually ignore these files.
utils/check_repo.py
Outdated
There was a problem hiding this comment.
redundant check in our current folder structure
utils/check_repo.py
Outdated
There was a problem hiding this comment.
We don't have rst doc files for quite a long time
utils/check_repo.py
Outdated
There was a problem hiding this comment.
We don't have rst doc files for quite a long time
utils/check_repo.py
Outdated
There was a problem hiding this comment.
nit: with the addition of spacing, we can clearly see that these prints belong to check_repo.py in make fixup, as opposed to a blob of text 🤗
utils/check_repo.py
Outdated
There was a problem hiding this comment.
Note: I intend to use this new mapping in check_docstrings, to perform basic quality checks on the docstring of publicly documented methods
252a056 to
cd2e601
Compare
|
arf, this is getting docker image issues due to imports |
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
9230164 to
69ef594
Compare
a72b443 to
2846753
Compare
|
Cool tool @gante! LMK when you want me to take a look! |
2846753 to
eba80cf
Compare
|
@LysandreJik the PR is now ready 🙌 (it was failing before because the check repository CI image didn't have all needed dependencies to check methods in objects) |
LysandreJik
left a comment
There was a problem hiding this comment.
Nice, clean! And love the indentation, I agree it makes everything cleaner.
Thanks for the comments, helped understanding how the code work.
What does this PR do?
Adds a check to confirm that publicly documented methods exist. For instance, commenting out a publicly documented method like
DynamicCache.to_legacy_cachetriggers this check, which in essence is a reminder to be extra careful with methods tagged as documented.In the process, also removed some old, unused logic.