Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix wrong path in some doc #25658

Merged
merged 2 commits into from
Aug 23, 2023
Merged

fix wrong path in some doc #25658

merged 2 commits into from
Aug 23, 2023

Conversation

ydshieh
Copy link
Collaborator

@ydshieh ydshieh commented Aug 22, 2023

What does this PR do?

The examples use a path this is (likely) moved to the current one some time ago. Let's update those.

@ydshieh
Copy link
Collaborator Author

ydshieh commented Aug 22, 2023

Pong Sir Arthur 😄

Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to remove them from no_doctest.txt? 👀 to have a preview

@ydshieh
Copy link
Collaborator Author

ydshieh commented Aug 22, 2023

can give it a try!

@ydshieh
Copy link
Collaborator Author

ydshieh commented Aug 22, 2023

It passes, but doctest doesn't really run any test from that doc file. (nothing is collected)

See https://app.circleci.com/pipelines/github/huggingface/transformers/71009/workflows/d047f9a7-21ee-457b-b921-05eefbeedd88/jobs/892220/steps

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Aug 22, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Collaborator

@ArthurZucker ArthurZucker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix, guessing no tests are run because there is no python code ? (If I remember correctly)

@ydshieh
Copy link
Collaborator Author

ydshieh commented Aug 23, 2023

Most of them are bash. Some are python, but as python no-style. There is a single block with python, but that is not really to be tested as a doc string example.

I didn't check the regular expression to see why those python-related blocks are not tested.

@ydshieh
Copy link
Collaborator Author

ydshieh commented Aug 23, 2023

It's probably that file has cuda, and for md file, if a cuda shows up, all the tests in that file won't be collected (by the new logic of doc test you and me implemented)

@ydshieh ydshieh merged commit 3d1edb6 into main Aug 23, 2023
3 checks passed
@ydshieh ydshieh deleted the fix_doc branch August 23, 2023 06:34
parambharat pushed a commit to parambharat/transformers that referenced this pull request Sep 26, 2023
* update

* check

---------

Co-authored-by: ydshieh <[email protected]>
blbadger pushed a commit to blbadger/transformers that referenced this pull request Nov 8, 2023
* update

* check

---------

Co-authored-by: ydshieh <[email protected]>
EduardoPach pushed a commit to EduardoPach/transformers that referenced this pull request Nov 18, 2023
* update

* check

---------

Co-authored-by: ydshieh <[email protected]>
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.

3 participants