Update README.md #25851
Update README.md #25851
Conversation
broken link on documentation tests, now fixed.
amyeroberts
left a comment
amyeroberts
left a comment
There was a problem hiding this comment.
Thanks for many fixes to our docs!
For this PR, the link is out dated because the file doesn't exist since #25680. We can remove the whole section instead.
docs/README.md
Outdated
| To include your example in the daily doctests, you need to add the filename that | ||
| contains the example docstring to the [documentation_tests.txt](../utils/documentation_tests.txt). | ||
| contains the example docstring to the [documentation_tests.txt](https://github.com/huggingface/transformers/blob/main/utils/slow_documentation_tests.txt). |
There was a problem hiding this comment.
We can get rid of this line completely, documentation_tests.txt has been removed and the user doesn't need to add the tests anywhere
There was a problem hiding this comment.
It's my pleasure! Should I create another PR and delete the line?
There was a problem hiding this comment.
Nope - you can keep this one, make the change and update the PR description
deleted the line containing documentation tests
amyeroberts
left a comment
amyeroberts
left a comment
There was a problem hiding this comment.
Thanks for updating this!
@ydshieh Is there any additional info about doc testing we should add / update alongside this change?
| To include your example in the daily doctests, you need to add the filename that | ||
| contains the example docstring to the [documentation_tests.txt](../utils/documentation_tests.txt). |
There was a problem hiding this comment.
There is a new file named utils/not_doctested.txt. For a file to be doctested, it SHOULD NOT be in that file. We can add a sentence at this place :-)
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. |
|
Hi @NinoRisteski Sorry we forgot to merge this PR, and it ends up being done in another PR #26213. We really appreciate your contribution and I want to apologize for what happens here 🙏 . |
4 participants
broken link on documentation tests, now fixed.