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: docs warnings #1184

Merged
merged 3 commits into from
Jan 7, 2025
Merged

Conversation

pedroafabri
Copy link
Contributor

@pedroafabri pedroafabri commented Jan 7, 2025

This PR addresses the warnings that were occurring during the documentation generation process.

Fixed Issues:

  • Escaped characters that were generating warnings;
  • Resolved most warnings related to broken links;
  • For links that could not be fixed internally, I added references to the docs.rs website to provide some context;
  • Removed links to private functions/constants and explicitly stated their private nature;

Known Issue:

While generating the documentation, two warnings about output filename collision may still appear. This is a KNOWN ISSUE with Cargo and unrelated to the changes introduced in this PR.

Let me know if further adjustments are needed!

Fixed broken links and escaped characters to remove warnings while
generating documentation

✅ Closes: openvm-org#1126
@pedroafabri pedroafabri mentioned this pull request Jan 7, 2025
Copy link
Contributor

@jonathanpwang jonathanpwang left a comment

Choose a reason for hiding this comment

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

LGTM tyvm!

@jonathanpwang jonathanpwang changed the title Fix/docs warnings fix: docs warnings Jan 7, 2025
@jonathanpwang jonathanpwang merged commit bb0d4c5 into openvm-org:main Jan 7, 2025
22 of 23 checks passed
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.

2 participants