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.

Sign up for GitHub

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

Jump to bottom

Fix rustdoc warnings #1126

Closed
jonathanpwang opened this issue Dec 23, 2024 · 5 comments
Closed

Fix rustdoc warnings #1126

jonathanpwang opened this issue Dec 23, 2024 · 5 comments
Assignees
@pedroafabri
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jonathanpwang
Copy link
Contributor

There are some warnings when you run cargo doc --workspace mainly related to url links and missing <>, etc.
@jonathanpwang jonathanpwang added good first issue Good for newcomers help wanted Extra attention is needed labels Dec 23, 2024
@pedroafabri
Copy link
Contributor

Hi, I'd like to work on this issue. Could you please assign it to me?

Let me know if there's any additional context or guidelines I should follow.

@jonathanpwang
Copy link
Contributor Author

Assigned!

I don't think there's much additional context necessary: we just want to follow whatever cargo doc --workspace suggests to ensure the docs work properly.

If you're new to cargo doc, refer to the official documentation.

@pedroafabri
Copy link
Contributor

Perfect, thanks!

Is there any PR template, branch naming pattern or something like that?

I've read the Contributor's Docs but found nothing about it there.

@jonathanpwang
Copy link
Contributor Author

We are pretty laid back about format, as long as you make a PR off of main and explain in the PR description what you're doing, that's good enough :)

pedroafabri added a commit to pedroafabri/openvm that referenced this issue Jan 7, 2025
@pedroafabri
docs: ✏️ Fixed documentation warnings
c762581 
Fixed broken links and escaped characters to remove warnings while
generating documentation

✅ Closes: openvm-org#1126
@pedroafabri
Copy link
Contributor

I’ve opened a PR to address this issue: #1184

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pedroafabri pedroafabri

Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pedroafabri @jonathanpwang