commitizen icon indicating copy to clipboard operation
commitizen copied to clipboard

docs(config.md): fix format issue, add period and add title to example config code blocks

Open bearomorphism opened this issue 6 months ago • 1 comments

Description

Checklist

Documentation Changes

  • [x] Run poetry doc locally to ensure the documentation pages renders correctly
  • [x] Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

bearomorphism avatar Jun 10 '25 12:06 bearomorphism

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 97.96%. Comparing base (120d514) to head (5f285b5). :warning: Report is 757 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1534      +/-   ##
==========================================
+ Coverage   97.33%   97.96%   +0.62%     
==========================================
  Files          42       58      +16     
  Lines        2104     2703     +599     
==========================================
+ Hits         2048     2648     +600     
+ Misses         56       55       -1     
Flag Coverage Δ
unittests 97.96% <ø> (+0.62%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codecov[bot] avatar Jun 10 '25 12:06 codecov[bot]