Skip to content

fix: Repair CI — ruff format drift and broken .NET doc image links - #456

Merged
DaveSkender merged 2 commits into
mainfrom
fix/ruff-format-docs
Jul 27, 2026
Merged

fix: Repair CI — ruff format drift and broken .NET doc image links#456
DaveSkender merged 2 commits into
mainfrom
fix/ruff-format-docs

Conversation

@DaveSkender

@DaveSkender DaveSkender commented Jul 27, 2026

Copy link
Copy Markdown
Member

Fixes both CI failures in this repo. They are unrelated to each other and neither was caused by a code change here — both are external drift that turned every PR red.

1. lint-and-test → Ruff format check

requirements-test.txt pins no ruff version, so CI installs the newest release. Ruff 0.16 formats Python code blocks embedded in Markdown, pulling docs/**/*.md into ruff format --check for the first time. 23 doc files had never been formatted.

Verified against the version CI uses (ruff 0.16.0): 23 files would be reformatted304 files already formatted. ruff check . passed throughout — lint was never the problem.

Every edit is inside a fenced ```python block; no prose, front matter, or fence lines touched. Several are real improvements to the examples:

  • stray C#-style semicolons removed — indicators.get_doji(quotes);indicators.get_doji(quotes)
  • argument spacing — get_kama(quotes, 10,2,30)get_kama(quotes, 10, 2, 30)
  • PEP 8 blank lines before class, and [ x for ... ][x for ...]

2. test → Test for broken URLs (83 HTML-Proofer failures)

DaveSkender/Stock.Indicators was renamed to facioquo/stock-indicators-dotnet, and its v3.0.0 VitePress migration (896ae089) deleted docs/assets/charts/, renaming the surviving images to kebab-case. raw.githubusercontent.com does not follow repo renames, so all 82 chart images plus examples.webp began returning 404.

Repointed site.dotnet.charts to d0b99458 — the last commit carrying the complete PascalCase set. All 82 URLs plus examples.webp verified returning HTTP 200.

A pinned commit rather than main is deliberate: four referenced images (AdIndex, Correlation, HeikinAshi, StdDevChannelsFull) have no equivalent in the current tree, so pointing at today's kebab-case assets would still leave four broken links and require deciding what to show instead. That is a docs-content call, not a CI fix. Also updated the stale repo/src URLs to the new org.

Follow-ups worth considering

  • Unpinned linter: a future ruff release can redden every PR with no commit. Pin ruff (with Dependabot) or exclude docs/** from formatting.
  • Chart images: to track the .NET repo's live assets, the 78 that survived need PascalCase → kebab-case remapping, and the 4 orphans need a decision.
  • Prose links to github.com/DaveSkender/Stock.Indicators/discussions in contributing.md are left alone — github.com does follow renames, so they resolve and pass.

Ruff 0.16 formats Python code blocks inside Markdown, so the docs
examples began failing 'ruff format --check' without any change to the
repo. Reformats the 23 affected files; changes are confined to fenced
python blocks.
@facioquoqa

facioquoqa Bot commented Jul 27, 2026

Copy link
Copy Markdown

:neckbeard: FaciōQuōqa Mage automatic code review is disabled in your mage.yml

  • Trigger review

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository YAML (base), Central YAML (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 7fcc82c5-df5f-411e-aaad-c7dae3ed3a74

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch fix/ruff-format-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

The Stock.Indicators repo moved to facioquo/stock-indicators-dotnet and
v3.0.0 migrated its docs to VitePress, deleting docs/assets/charts.
raw.githubusercontent does not follow repo renames, so all 82 chart
images plus examples.webp returned 404 and HTML-Proofer failed.

Pin to d0b99458, the last commit carrying the full PascalCase set.
@DaveSkender DaveSkender changed the title style: Apply ruff format to docs code blocks fix: Repair CI — ruff format drift and broken .NET doc image links Jul 27, 2026
@DaveSkender
DaveSkender merged commit 6e53442 into main Jul 27, 2026
19 checks passed
@DaveSkender
DaveSkender deleted the fix/ruff-format-docs branch July 27, 2026 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

1 participant