Skip to content

fix(docs): use updated usage of doc_auto_cfg and fix internal link#1373

Merged
orhun merged 1 commit intoorhun:mainfrom
sermuns:main
Feb 14, 2026
Merged

fix(docs): use updated usage of doc_auto_cfg and fix internal link#1373
orhun merged 1 commit intoorhun:mainfrom
sermuns:main

Conversation

@sermuns
Copy link
Copy Markdown
Contributor

@sermuns sermuns commented Feb 14, 2026

Description

The docs are failing for git-cliff-core.

https://docs.rs/crate/git-cliff-core/latest

This PR addresses that.

I also noticed there was a broken internal link, which I resoled by using the fully qualified path.

Motivation and Context

rust-lang/rfcs#3631 has been merged, which removes #![cfg_attr(docsrs, feature(doc_auto_cfg))].

How Has This Been Tested?

According to https://docs.rs/about/builds, docs.rs uses nightly-2026-02-13 to build docs.

I ran

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly-2026-02-13 doc --all-features --no-deps

and no warnings or errors showed, so it seems to work?

Screenshots / Logs (if applicable)

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (no code change)
  • Refactor (refactoring production code)
  • Other

Checklist:

  • My code follows the code style of this project.
  • I have updated the documentation accordingly (if applicable).
  • I have formatted the code with rustfmt.
    • cargo +nightly fmt --all
  • I checked the lints with clippy.
    • cargo clippy --tests --verbose -- -D warnings
  • I have added tests to cover my changes.
  • All new and existing tests passed.
    • cargo test

@sermuns sermuns requested a review from orhun as a code owner February 14, 2026 14:21
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.67%. Comparing base (cbf2115) to head (ddd9449).
⚠️ Report is 68 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1373   +/-   ##
=======================================
  Coverage   47.67%   47.67%           
=======================================
  Files          24       24           
  Lines        2117     2117           
=======================================
  Hits         1009     1009           
  Misses       1108     1108           
Flag Coverage Δ
unit-tests 47.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Owner

@orhun orhun left a comment

Choose a reason for hiding this comment

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

thx!

@orhun orhun merged commit 0a0a795 into orhun:main Feb 14, 2026
97 of 98 checks passed
@welcome
Copy link
Copy Markdown

welcome Bot commented Feb 14, 2026

Congrats on merging your first pull request! ⛰️

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.

3 participants