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

Inaccurate code example within inline code-documentation #29661

Merged
merged 2 commits into from
Mar 14, 2024

Conversation

MysteryManav
Copy link
Contributor

@MysteryManav MysteryManav commented Mar 14, 2024

Changes the inline code-documentation for better and accurate example

Fixes #27142

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you read the contributor guideline,
    Pull Request section?
  • Was this discussed/approved via a Github issue or the forum? Please add a link
    to it if that's the case.
  • Did you make sure to update the documentation with your changes? Here are the
    documentation guidelines, and
    here are tips on formatting docstrings.
  • Did you write any new necessary tests?

@MysteryManav
Copy link
Contributor Author

MysteryManav commented Mar 14, 2024

@amyeroberts i have changed the inline-documentation in the following files:

  1. modeling_vision_encoder_decoder.py
  2. modeling_trocr.py

I am not sure if the change in modeling_git.py would be helpful or not, so please do look into that, and if there are other files that require the same change, if i am correct, most of the files that start with "modeling_" have the documentation, should i apply the changes to those too ? I have not changed other files, since it seems that might caues some functionalities to break

Copy link
Collaborator

@amyeroberts amyeroberts 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 working on this!

No need to make changes in other modeling files - this fix is specific to TrOCR

@HuggingFaceDocBuilderDev

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.

@amyeroberts amyeroberts merged commit 56b64bf into huggingface:main Mar 14, 2024
8 checks passed
@MysteryManav MysteryManav deleted the inaccurate_code_example branch March 15, 2024 06:35
itazap pushed a commit that referenced this pull request May 14, 2024
* docs:inaccurate_code_example

* Inaccurate code example within inline code-documentation
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.

Inaccurate code example within inline code-documentation
3 participants