Skip to content

Fix/rustdoc warnings#2045#2084

Merged
mre merged 7 commits into
lycheeverse:masterfrom
krishnakurtakoti:fix/rustdoc-warnings#2045
Jun 2, 2026
Merged

Fix/rustdoc warnings#2045#2084
mre merged 7 commits into
lycheeverse:masterfrom
krishnakurtakoti:fix/rustdoc-warnings#2045

Conversation

@krishnakurtakoti

@krishnakurtakoti krishnakurtakoti commented Mar 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fixes issues/2045

thomas-zahner
thomas-zahner requested changes Mar 11, 2026
View reviewed changes
Comment thread lychee-bin/src/options.rs Outdated
Comment thread lychee-bin/src/options.rs Outdated
Comment thread lychee-bin/src/options.rs Outdated
Comment thread lychee-bin/src/options.rs Outdated
Comment thread lychee-lib/src/ratelimit/mod.rs Outdated
Comment thread lychee-lib/src/types/request_error.rs Outdated
Comment thread lychee-lib/src/types/input/input.rs Outdated
@krishnakurtakoti

krishnakurtakoti commented Mar 17, 2026

Copy link
Copy Markdown
Contributor Author

Made suggested changes. Please check.

@thomas-zahner

thomas-zahner commented Mar 18, 2026 •
edited by mre
Loading

Copy link
Copy Markdown
Member

Thank you for applying my suggestions, all changes look good now. However, in the current state the PR does not fix the mentioned issue so there are still things to do.

  • Fix all rustdoc warnings (cargo doc --no-deps still yields warnings)
  • Remove continue-on-error: true in linting step
  • CI doesn't pass, test failures need to be addressed

As a side-note I feel like the current PR description doesn't really help. It's really verbose and contains repeated content from my contents as well as confusing parts (e.g. Rule of Thumb) that seem to come from a LLM. Maybe you could shorten the description to the essential parts, or just leave the first line.

@katrinafyi katrinafyi mentioned this pull request Mar 23, 2026
Merged
@thomas-zahner

thomas-zahner commented Mar 23, 2026

Copy link
Copy Markdown
Member

@katrinafyi now addressed the comment I referenced previously with caa7d5c. Consequently I've updated my above comment.

I recommend you to now rebase this PR on master, so that you can test the changes with this new commit included. You can then remove the line with continue-on-error: true and update the name of the step. Next you should address all warnings/errors which you can now see in the CI step.

@mre

mre commented Apr 25, 2026

Copy link
Copy Markdown
Member

@krishnakurtakoti, can you rebase this branch on top of master?

krishnakurtakoti and others added 6 commits June 2, 2026 12:42
@krishnakurtakoti @mre
fix: resolve rustdoc warnings (unresolved links and HTML tags)lycheev…
20d286c 
…erse#2045
@krishnakurtakoti @mre
fix: resolve rustdoc warnings (unresolved links and HTML tags)lycheev…
40f8d98 
…erse#2045
@krishnakurtakoti @mre
remove unneeded gitignore files, added mistakenly
3463769
@krishnakurtakoti @mre
Made changes as per code review suggestions.
ec6374f
@krishnakurtakoti @mre
Resolve links by adding correct path
59bba7d
@mre
Fix remaining rustdoc warnings and enforce in CI
9133386 
- Use plain backticks for private intra-doc link `Chain::traverse`.
- Fully qualify `crate::ResolvedInputSource::Stdin` in `BaseInfo` doc.
- Wrap CLI/shell examples in `text`/`bash` fenced code blocks so rustdoc
  does not try to parse them as Rust.
- Drop `continue-on-error` from the rustdoc CI step and pass
  `RUSTDOCFLAGS=-D warnings` so future warnings fail the build.
@mre mre force-pushed the fix/rustdoc-warnings#2045 branch from dbb0806 to 9f5d42d Compare June 2, 2026 11:06
@mre mre force-pushed the fix/rustdoc-warnings#2045 branch from 52ff44e to 9df37c5 Compare June 2, 2026 11:23
mre
mre approved these changes Jun 2, 2026
View reviewed changes

@mre mre left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for your contribution @krishnakurtakoti.
I went ahead and fixed the remaining issues.
Will merge this as the changes should be uncontroversial as they only fix lints.

@mre mre merged commit 47e387e into lycheeverse:master Jun 2, 2026
7 checks passed
@mre mre mentioned this pull request Jun 2, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mre mre mre approved these changes

@thomas-zahner thomas-zahner Awaiting requested review from thomas-zahner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix rustdoc warnings

3 participants

@krishnakurtakoti @thomas-zahner @mre