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

Mass conversion of documentation from rst to Markdown #14866

Merged
merged 12 commits into from
Dec 21, 2021
Merged

Conversation

sgugger
Copy link
Collaborator

@sgugger sgugger commented Dec 21, 2021

What does this PR do?

This PR treats a lot of docstrings and converts them from rst to Markdown. All of the remaining one.

It also includes a new repo consistency check that will detect someone does not add back some rst docstrings behind my back. 😈

@sgugger
Copy link
Collaborator Author

sgugger commented Dec 21, 2021

As seen with @LysandreJik, merging and inspecting the result in the doc. Failure is unrelated.

@sgugger sgugger merged commit 27b3031 into master Dec 21, 2021
@sgugger sgugger deleted the more_doc_conversion branch December 21, 2021 20:06
Albertobegue pushed a commit to Albertobegue/transformers that referenced this pull request Jan 27, 2022
)

* Convert docstrings of all configurations and tokenizers

* Processors and fixes

* Last modeling files and fixes to models

* Pipeline modules

* Utils files

* Data submodule

* All the other files

* Style

* Missing examples

* Style again

* Fix copies

* Say bye bye to rst docstrings forever
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.

1 participant